This repo contains the source content and build scripts for the Reclaimers Library (https://c20.reclaimers.net). It aims to document the immense tribal knowledge of the Halo modding community and covers game engine details, the Halo Editing Kit, community tools, and guides for map-making.
The library is not yet directly editable online, but there are still various paths to contribute:
- Submitting tips in #wiki-dump in our Discord or as GitHub issues, for other editors to add.
- Submitting small edits as pull requests via GitHub.
- Forking the project, developing it locally with previews, and submitting larger content pull requests.
Content is written in a combination of Markdoc-flavoured markdown and YAML files for structured data like tag layouts. For more information, see the Contributing page.
If you intend to make code changes to c20, or want to write larger content additions with previews, you can fork and clone the repo locally with Git. You'll need Node.js installed to run the site locally. If you're unfamiliar with Git and command line usage, you probably want to stick to one of the other contributing paths.
Once those are installed, clone the project and run these shell commands to get the site running locally:
# install dependencies (run once)
npm ci
# start the development server
npm run devYou can now visit http://localhost:8080/ in a browser and see the website. Edit content source files, then refresh your browser to see changes. You can run the server on a different port with C20_PORT=9001 npm run dev.
The development server renders pages on-demand, but you can also run npm run static to fully render all pages to HTML and serve them. A full static build takes longer and isn't recommended for quick content writing. You can use it as a final step to verify the build will work once changes are merged. Note: FFmpeg is an optional dependency used to generate video thumbnails during a full build. It needs to be available on your system PATH. Windows users can simply download ffmpeg.exe and place it in the project root. If you don't want to set up FFmpeg just run C20_NO_THUMBNAILS=true npm run static and thumbnails won't be used.
Under src/utility_scripts you'll find some helper scripts for managing wiki content. You can run a typescript-based script like npx ts-node src/utility_scripts/hs_doc.ts while some others will need python.
The website is currently hosted as a static site in AWS S3, fronted by a CloudFront CDN distribution, managed in reclaimers-aws. To deploy a new version, simple make changes to the master branch and a build/deploy will be triggered automatically with CodeBuild.
As a backup, users with bucket permission can simply sync the dist directory to S3:
aws s3 sync --delete ./dist s3://reclaimers-wiki-files/Because of cache TTLs, content may not appear updated immediately. An invalidation can be run in CloudFront to force updates but it will not affect clients unless they clear their browser cache. Live content can be seen by directly viewing the S3 hosting origin.
C20's codebase is licensed under version 3.0 of the GNU General Public License. A copy of its text can be found in COPYING.
The content of its pages, including articles, guides, images, tag descriptions, and other rendered metadata are available under the under the CC BY-SA 3.0 license.