brandon-df/docs

Momentum Mod Documentation: Guides, Entities, Console Commands and Variables

A documentation website for Momentum Mod, running on Jekyll and using the Minimal Mistakes theme.

All documentation is kept up with the game's development branch not our current release version on Steam.

What This Is

This repo is an open source collection of documentation for various aspects of the game Momentum Mod. This includes (but is not exactly limited to):

• Documenting Momentum's console commands
• Documenting Momentum's console variables
• Documenting Momentum's custom entities
• Guides for using Momentum Mod or related tools (zone tools, custom entities, etc)
• Guides for mapping (related to Momentum and/or its gametypes)

What This Isn't

This repo and website should pertain to being only about the game Momentum Mod and its related gametypes (Surf, Bhop, RJ, KZ, etc).

This means we do NOT want:

• General guides about Hammer (this isn't TopHattWaffle / Valve Dev Wiki)
• Off-topic articles (this isn't Medium)
• Map-specific articles (this isn't a wikia)

This may change in the future, but for now, keep it about Momentum.

Contributing

Pull Requests are highly appreciated! Just branch off of master, make your edits, and open a Pull Request into master describing what you changed. Pages could be edited directly through GitHub, or you can download your fork and edit through a program like Visual Studio Code.

If you need a guide for how to contribute, one can be found on the how-to page on the documentation site. Another good resource is to simply look at existing posts, or past commits for reference. Furthermore, another good reference could be asking around in the Momentum Mod Discord server.