Skip to content

Documentation for the fomod installer format.

License

Notifications You must be signed in to change notification settings

GandaG/fomod-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fomod Documentation

A game-agnostic mod installer format.

You can find the full documentation for this format at fomod-docs.rtfd.io.

For simple issues use the issue tracker at Github.

There are a number of associated repositories that might be worth checking out:

  • fomod-schema, which maintains and develops the schema that governs this format.
  • fomod-validator, a very simple app that validates and checks installers for mistakes.
  • fomod-designer, an app that lets you build your installer in a simpler way with a graphical interface.
  • pyfomod, for developers, a python package that forms the backbone of all apps listed here.

Contributing

Build Status

If you're not familiar with the terms used, we have a glossary at the end for you! Try hovering over the unknown words, that might help too.

Building the documentation

The documentation is automatically built and uploaded to ReadTheDocs whenever it's pushed to this repo, however it may be useful to build locally to find typos and other errors before pushing.

These instructions are for Linux only, I don't have a Windows machine available to test building and I never even came physically close to a Mac.

Setup

Follow the instructions on setting up a virtualenv from here and then:

sudo apt install -y make
make setup

Build

make

Cleanup

make clean

Glossary

Git
Git is a version control system. You can learn more about them and git here.
Commit
Committing modifications to files creates a snapshot of your project. This is incredibly useful if you ever need to revert changes, to look at who made some changes or to allow multiple people to work on something at the same time. Like we're doing!
Pull Request
Pull requests allow you to ask for a set of changes to another repository. You can learn more about them here.
Issues, Tickets and Issue Tracker
The issue tracker is the place where you can open a ticket aka issue. Use these to leave feedback and suggestions! You can learn more about them here.
Linting
Linting documents is simply checking for errors. In our case, we check for compliance with a specific set of rules to enforce (the schemas). You can learn more about it here.

Releases

No releases published

Packages

No packages published