Page MenuHomeSchine - Phabricator

Starmade | Log files have an unexpected file extension
Closed, FinishedPublic

Description

The client and server log files are named (server)log.txt.#.

Most operating systems/file browsers identify files by their "extension". The extension of log files should be .txt or .log so OSs report correct file types, and improve user experience when trying to upload log files to the support forum.

Change log.txt.# to log.#.txt
Effect: OS and forum software recognizes files as valid type
Side effects: alpha sort order is not affected

Details

Task Type
Bug
Testing Results
Affected Gamemode(s)
none/unspecified
Reproducible
Yes
Last tested (version)
0.199.143
Category
Tools (Starmote...)
First occurrence (version)
0.15
Hardware/Software/System
OS-Specific
No
Hardware-Specific
No
Video Card Vendor
uncertain
Serverconfig (server.cfg)
<replace this line with the file content>
Clientconfig (settings.cfg)
<replace this line with the file content>

Event Timeline

Valck created this task.Jul 17 2016, 5:02 PM

-validated-

True...There's probably a reason for it but I'll put it in queue. Schema can reject it if he won't change it.

lancake shifted this object from the S1 Public space to the S3 Starmade space.Jul 17 2016, 9:58 PM
lancake changed the visibility from "Custom Policy" to "Public (No Login Required)".
lancake changed the edit policy from "Task Author" to "Starmade (Project)".
lancake changed Reproducible from uncertain to Yes.
lancake set Last tested (version) to 0.198.479.
lancake changed Category from none/unspecified to Tools (Starmote...).
lancake set First occurrence (version) to 0.15.
lancake moved this task from New / Unconfirmed to Open / Validated on the Issue Navigation board.
lancake moved this task from Open / Validated to Confirmed on the Issue Navigation board.
lancake changed the task status from Open to In Queue (Game).
lancake claimed this task.
lancake triaged this task as Trivial priority.
Restricted Application edited projects, added Game Development; removed Issue Navigation. · View Herald TranscriptJul 17 2016, 9:59 PM
Benevolent27 added a subscriber: Benevolent27.EditedJul 31 2016, 7:27 AM

This does make sense, however if this could be an option in the server.cfg file, that would be ideal. I recommend this because the change would break wrappers and other scripts that utilize the log files. (Including scripts I have created) Though I don't mind updating my scripts, there are people that rely on scripts that they have not created and this would create problems for them.

calani added a subscriber: calani.Aug 2 2016, 5:18 PM

Wouldn't StarMade.#.log be more semantically correct?

Also: What do the numbers mean? Is there something more descriptive we could replace them with?
If they're simply the previous game logs, the first (and therefore active) log should simply be StarMade.log; for further clarity, we could move the previous logs to a previous logs subdirectory.

0 - 20 is numbering of the logs 0 newest 20 oldest ... a new one pushes all other one to 20 .. 21 is deleted. .. afaik

lancake raised the priority of this task from Trivial to Release Blocker.
Restricted Application added a subscriber: AndyP. · View Herald TranscriptAug 9 2016, 6:11 PM
calani added a comment.Aug 9 2016, 7:16 PM

Suggestion:

Current log: logs/StarMade.log
Previous logs: logs/previous/StarMade.yyyy-mm-dd.hh-mm-ss.log

All logs will thus be easy to locate, and will be in chronological order when sorted either alphanumerically or by created date. They will also present the OS's log icon and any other special behavior.

To clean up: fetch the logs/previous/StarMade.*.log file listing, sort by filename, and remove the 21st log and onward.


I may do something similar for the launcher.

schema changed the task status from In Queue (Game) to Resolved.Aug 10 2016, 4:05 PM
Restricted Application edited projects, added Quality Assurance; removed Game Development. · View Herald TranscriptAug 10 2016, 4:05 PM
lancake closed this task as Closed.Aug 11 2016, 1:38 PM

-QA Testing-

log.txt.# -> logstarmade.#.log
serverlog.txt.# -> serverlog.#.log

Restricted Application removed a project: Quality Assurance. · View Herald TranscriptAug 11 2016, 1:38 PM
Restricted Application removed a subscriber: AndyP. · View Herald Transcript
lancake changed Last tested (version) from 0.198.479 to 0.199.143.Aug 11 2016, 1:39 PM
Restricted Application added a project: Tools. · View Herald TranscriptMar 10 2017, 6:10 PM