API documentation for mod.io - a modding platform for game developers
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
lib
source
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE
README.md
Vagrantfile
config.rb
deploy.sh
font-selection.json

README.md

mod.io

API Documentation

License Discord Master docs

Documentation for mod.io is powered by slate, a static API generator and can be read here (also see our getting started guide). We use swagger.io to define our API from comments in our codebase, and generate the slate markdown files from it using widdershins.

Output

We recommend you don't edit source/index.html.md as this file is generated automatically via the above process. You can edit the presentation and source/includes/_modio.md as these are manually created.

Setup

To get our slate documentation up and running on your local machine, we recommend you follow the instructions on the official slate repository page.

Contributions Welcome

Want to correct errors in our documentation or it's layout? Submit a pull request with your recommended changes to be reviewed.

Other Repositories

Our aim with mod.io, is to provide an open modding API. You are welcome to view, fork and contribute to our other codebases in use:

  • Design is public and open source, the repository can be found here.
  • SDK is public and open source, the repository with documentation can be found here. Game developers are welcome to utilize it directly, to add support for mods in their games, or extend it to create plugins and wrappers for other engines and codebases.
  • Browse engine tools, plugins and wrappers created by the community, or share your own.
  • Unity plugin, easily manage the browsing and install of mods in Unity Engine games.