Total War Rome 2 Docs

About

This project is an community attempt to document the Total War Rome 2 game files. The goal is to provide a comprehensive and user-friendly resource for modders and players alike. For source code visit https://github.com/bukowa/twr2docs

How to work with the documentation

1. Install Python 3.13.1 or later.
2. Install the required packages:

pip install -r requirements.txt

3. Go to the docs directory:

cd r2docs

4. Serve the documentation locally:

mkdocs serve

Contributing

If you would like to contribute to this project, please follow these steps:

1. Fork the repository on Github and clone it to your local machine.

# replace YOURUSERNAME with your github username
git clone https://github.com/<YOURUSERNAME>/twr2docs.git
cd twr2docs

2. Create a new branch for your feature or bug fix.

 git checkout -b feature/my-feature

3. Make your changes and commit them.

 git add .
 git commit -m "Add my feature"

4. Push your changes to your forked repository.

git push origin feature/my-feature

5. Create a pull request to the main repository.