vegastrike / Assets-Masters

Vega Strike Upon The Coldest Sea Original Game Data Art Sources (e.g. hi-poly/hi-res source models/images)
8 stars 6 forks source link

Roman's VS Players' Guide #36

Closed romanyacik closed 2 years ago

romanyacik commented 2 years ago

ODT format instead of MS Word, for Roman's convenience. Work in progress for explanations of settings configuration

evertvorster commented 2 years ago

Thanks for putting the document in an open format.

Would it be too much to ask to remove the multiplayer section too? It's been ripped out of the game engine.

The list of contributors also has grown a bit, and new contributors should be added, please.

romanyacik commented 2 years ago

I'll see to the multi-player section this afternoon, but I'm a new contributor myself, so I'm not sure who did which tasks for me to include in the list of contributors. 

On Tue, Oct 12, 2021 at 3:07 AM, Evert @.***> wrote:

Thanks for putting the document in an open format.

Would it be too much to ask to remove the multiplayer section too? It's been ripped out of the game engine.

The list of contributors also has grown a bit, and new contributors should be added, please.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe. Triage notifications on the go with GitHub Mobile for iOS or Android.

BenjamenMeyer commented 2 years ago

Yes, thanks for adding an ODT version. That said, we probably need to drop ODT, DOC, etc and move to a format that is easily viewable/diffable on GitHub so we can review changes more easily without an external tool; we should also add tooling to generate the other forms via simple scripts.

As an example, Sphinx does this while using the RST format. There's similar engines for MD. Though we may be able to use the TEX format already and do this too:

Ultimately we need to be able to review the changes in the PR. The other formats can be generated and added to releases as needed with the appropriate tooling.

BenjamenMeyer commented 2 years ago

Per gitter conversation:

$ abiword --to=tex Romans_Revised_Vega_Strike_Players_Guide.odt
V - Variable ev was bound but is unused in the query
$ ls
14.jpg  19.jpg  26.jpg  30.png  33.png  36.png  3.jpg  6.jpg  Romans_Revised_Vega_Strike_Players_Guide.odt
15.jpg  21.jpg  28.jpg  31.png  34.png  37.png  4.jpg  8.jpg  Romans_Revised_Vega_Strike_Players_Guide.tex
16.jpg  23.jpg  29.png  32.png  35.png  38.jpg  5.jpg  9.jpg

You'll have to remap the images to existing images in the repo, and you may want to use a tool like Tex Studio (https://www.texstudio.org/) to update the outline after; though I'd probably apply it over the existing Tex document (https://github.com/vegastrike/Assets-Masters/blob/master/documentation/Vega_Strike_Players_Guide.tex), start with the diffs, and work from there.

Once we have an authoritative Tex document updated, then we can remove the other formats from the repo, and replace with some scripts to generate them.