Skip to content

Commit

Permalink
Merge branch 'main' into crosshair_table
Browse files Browse the repository at this point in the history
  • Loading branch information
NachosChipeados authored Oct 4, 2024
2 parents 93a8f95 + ed6596a commit bfcc377
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
Titanfall 2 + Northstar Modding Docs
====================================
# NorthstarDocs

This repo contains documentation and guides on most things you need to know about creating mods for Northstar.
This repo contains documentation and guides on most things you need to know about using and creating mods for Northstar.

It is partitioned into:
- the **Wiki** section which contains a variety of information on how to install and use Northstar as well as troubleshooting tips.
- the **Modding** section which contains all the information necessary to create mods for Northstar as well as further technical details for developing for Northstar.

Especially the technical documentation is not done yet and might be incorrect or outdated in some places.

If you have some knowledge to share, but don't want to write a PR, you can make an issue explaining what you know and we can try to integrate that into the docs.

Contributing
------------
## Contributing

The only prerequisites are python and pip. On Linux simply run `run.sh` in the root dir and in windows execute `run.ps1` with powershell in the root dir. You may need to change the Powershell execution policies in order to run the script.

Running the script will install all dependencies required and build the docs locally. The local version is available at [port 8000](http://127.0.0.1:8000/). The server will get opened in your browser when the script finishes.
When you change a file the server will automatically rebuild it and refresh your browser window.

If you get an error message while running the script on Windows, check the following GitHub issue: https://github.com/R2Northstar/NorthstarDocs/issues/106
6 changes: 3 additions & 3 deletions docs/Wiki/other/helping.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The bot also provides an online log of the entire ticket connected to the embed
A Discord bot created by birb and rewritten by H0L0 which allows you to run commands like `.status` and see how many people are currently online on Northstar, as well as commands such as `.search region aus` (which would search for Northstar servers with the region set to Australia).
You can check the [GitHub repo](https://github.com/hummusbird/northstar-bot) for more info on Northstar Servers.

### Spectre
### Reaper

A Discord bot created by Cyn with help from multiple people designed to automatically reply to specific errors messages, screenshots of error messages, and some more quality of life features for helpers.
You can check the [GitHub repo](https://github.com/itscynxx/Spectre) for more info on Spectre.
A Discord bot originally created by Cyn and forked by Gecko, designed to automatically reply to specific errors messages, screenshots of error messages, and some more quality of life features for helpers.
You can check the [GitHub repo](https://github.com/R2NorthstarTools/Reaper) for more info on Reaper.

0 comments on commit bfcc377

Please sign in to comment.