Tutorial and Documentation Resources

[{AR}MetalKiller]

Howdy and happy new year, everyone 

I've been modding SWBF for well over 10 years now, admittedly less frequent and with less ambition than other modders on this forum.
In the beginning, I started having conversation with people who already knew how to mod.
There was no tutorial to follow along, and I had to figure out a lot of stuff on my own.
The classic learning by doing experience.
Although there are plenty of tutorials and documentation resources available, it always bugged me that they were spread across multiple different platforms and presented in forms that may not be appealing to beginners.
Some documents even skipped the most interesting parts because they were trivial in the eyes of the writer or just too cumbersome to explain.
Further problems were dead links, incompatible software, .... you name it.
I understand that the community is a bit smaller these days than back in the day, and the demand for a unified resource collection might be close to zero.

However, I am wondering if there has never been made an effort to collect all the information that is out there about SWBF1 and SWBF2 in one place?
I am thinking about something similar to the Blender-MSH-IO reference manual from Sleepkiller or a Wiki page in general.
Having Screenshots, cross-references, TL:DR;, ... really lowers the initial threshold for new people to get started.

I am not really trying to convince anybody of something, but just want to hear your opinions on it.

[Led]

There is/was a fairly extensive site for SWBF2.  https://sites.google.com/site/swbf2modtoolsdocumentation/getting-started

If you want to do something here, you are more than welcome and we can host it either directly in forums or as another site (html/worpress/etc)

[{AR}MetalKiller]

Thanks for the link, very helpful!

[{AR}MetalKiller]

Howdy and a happy new year to everyone (again)!

Over the holidays, I kept busy with another side project and started a Markdown file based documentation for Battlefront 1.

Why?
- Markdown is a human-readable format that can be easily processed by machines as well.
- It is convenient for referencing, linking or keyword searching.
- File-based documentation can be used offline.
- A consistent documentation format makes it easier to find, discover and add more resources.

As there is not much content yet, you are more than welcome to contribute or share ideas for improvement.
I will keep adding summaries of from forum posts and the like to fill it with some life.


---
Side note:
For a few days, I got sidetracked and wrote a Markdown subset parser that represents a Markdown folder/file hierarchy as a node structure.
This node structure can be used to generate any other format.
The currently deployed documentation uses this parser to generate HTML files.
---


You can read more about it here: https://github.com/SWBF2004/SWBFdocumentation
A deployed version of the docs can be found here: https://swbf2004.github.io/SWBFdocumentation/ (sorry, I am no artist)
And here is an image of the docs locally hosted with a working search functionality:


Cheers!