ULTRADOCS

Documentation for all speedrun-related tech in ULTRAKILL, made by ULTRAKILL speedrunners.

❓ About ULTRADOCS ❓

ULTRADOCS is an open-source speedrun guide meant to document and guide all of the available speedrun strats for every level in the game, ULTRAKILL. The idea originally came from @Kano127 when he noticed a thread that I, (Darkn), made on speedrun.com titled "When Are We Getting Proper Speedrun Guides?". Kano came up to me about it, and after a bit of convincing, we now have ULTRADOCS.

📖 Contributing 📖

As a perk of ULTRADOCS being an open-source guide, anybody is able to copy this repository and make any changes that they may want to make. May that be correcting something, adding a missing strat, removing outdated strats, etc. You can simply follow the instructions below to get started.

📚 Build Instructions 📚

Important

The instructions below uses Node.js in order to install the required necessities for the website. However, you may use alternative package managers such as Bun or pnpm.

1. Fork this repository, then clone your forked repository.
2. Open your cloned repository, then open a terminal.
3. Run npm i then npm run docs:build to install all dependencies.
4. Run npm run docs:dev to start a live environment of the website.

Video Guide

build.instructions.tutorial.mp4

🌐 Modifying Files 🌐

Tip

To prove that your commits are made by you (or in other words, are signed), add a GPG key to Git (or Git-based GUIs like GitHub Desktop and GitKraken).

1. Go into the /docs/ folder, then select either the any or p-rank folder.
2. Open one of the layers, then one of the levels, and modify.
3. Save your changes and verify the changes have been made.
4. Commit, then push your changes to your forked repository.

Video Guide

modifying.files.tutorial.mp4

✨ Submitting Changes ✨

1. Click on Pull Requests, then New Pull Request
2. State the changes of the PR in the Title.
   • If needed, also state changes in the Description.
3. Submit your Pull Request, and wait for it to be reviewed.
4. If accepted, your changes will be for all to see at ULTRADOCS.

💜 Contributors 💜

Darkn	Kano127	cxn	CATPERFECT	eanra
Fishy	nsethiz	Angelica	vivyaann	humpster

❤️ made by the ULTRAKILL speedrunning community ❤️