{"id":19647148,"url":"https://github.com/openra/book","last_synced_at":"2026-03-02T16:42:18.708Z","repository":{"id":54521436,"uuid":"174721181","full_name":"OpenRA/book","owner":"OpenRA","description":"The OpenRA Book for players, modders / game makers, and developers alike!","archived":false,"fork":false,"pushed_at":"2022-02-16T22:28:36.000Z","size":4559,"stargazers_count":21,"open_issues_count":11,"forks_count":8,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-02-27T00:20:56.404Z","etag":null,"topics":["book","cc-by","guide","how-to","manual","mdbook","openra","openra-book"],"latest_commit_sha":null,"homepage":"https://www.openra.net/book/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenRA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-09T16:56:16.000Z","updated_at":"2024-09-11T06:57:40.000Z","dependencies_parsed_at":"2022-08-13T18:31:05.762Z","dependency_job_id":null,"html_url":"https://github.com/OpenRA/book","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/OpenRA/book","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenRA%2Fbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenRA%2Fbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenRA%2Fbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenRA%2Fbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenRA","download_url":"https://codeload.github.com/OpenRA/book/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenRA%2Fbook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30010141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T15:15:59.058Z","status":"ssl_error","status_checked_at":"2026-03-02T15:15:58.758Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","cc-by","guide","how-to","manual","mdbook","openra","openra-book"],"created_at":"2024-11-11T14:42:41.529Z","updated_at":"2026-03-02T16:42:18.690Z","avatar_url":"https://github.com/OpenRA.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# The OpenRA Book\n\nYou can find the built book at https://www.openra.net/book/\n\n[![Build Status](https://travis-ci.org/OpenRA/book.png)](https://travis-ci.org/OpenRA/book)\n\n## Contact Us\n\n- [chat with us on Discord]\n- [open an issue on GitHub]\n\n## License\n\nThe OpenRA Book is under the CC-BY 4.0 license.\n\nYou can find the full text in the [LICENSE] file.\n\nA non-legal human-friendly summary can be found\n[here](https://creativecommons.org/licenses/by/4.0/) on the Creative Commons\nwebsite.\n\nThat summary is not a substitute for the [LICENSE].\n\n## Requirements\n\n- [`mdbook`] version 0.4.x\n\n**NOTE**: macOS users will need to install `mdbook` via [`cargo`] since mdbook\ndoes not distribute macOS binaries. See [mdbook#installation] for more\ninformation.\n\n## Build the book\n\nTo build the book run the following from the repository's root:\n\n```\n$ mdbook build\n```\n\nThe output will be in the `build/html/` subdirectory.\n\nUsing `mdbook watch` will build the book automatically each time a Markdown file in the `src` directory is changed.\n\n## View the built book\n\nOpen it in your web browser of choice:\n\n_Firefox_:\n\n```\n$ firefox build/html/index.html                       # Linux\n$ open -a \"Firefox\" build/html/index.html             # OS X\n$ Start-Process \"firefox.exe\" .\\build\\html\\index.html # Windows (PowerShell)\n$ start firefox.exe .\\build\\html\\index.html           # Windows (Cmd)\n```\n\n_Chrome_:\n\n```\n$ google-chrome build/html/index.html                 # Linux\n$ open -a \"Google Chrome\" build/html/index.html       # OS X\n$ Start-Process \"chrome.exe\" .\\build\\html\\index.html  # Windows (PowerShell)\n$ start chrome.exe .\\build\\html\\index.html            # Windows (Cmd)\n```\n\n## Serving the book locally\n\nWhen serving the book, pages will automatically be updated when the associated\nsource files are written to.\n\nRun the following from the repository's root:\n\n```\n$ mdbook serve\n```\n\nThen navigate to http://localhost:3000 in your web browser of choice.\n\nYou can run `mdbook help serve` for `serve`-specific options such as changing\nthe port used.\n\n## Contributing\n\nWe'd love your help!\n\n### Review in-progress work\n\nOur [open pull requests] are new chapters or edits that we're currently working\non. We would love if you would read through those and make comments for any\nsuggestions or corrections!\n\n### Translations\n\nWe can not translate the book because [`mdbook` doesn't support translations]\nyet.\n\n  [`cargo`]: https://doc.rust-lang.org/cargo/\n  [`mdbook` doesn't support translations]: https://github.com/rust-lang-nursery/mdBook/issues/5\n  [`mdbook`]: https://github.com/rust-lang-nursery/mdBook/\n  [chat with us on Discord]: https://discord.openra.net\n  [LICENSE]: ./LICENSE\n  [mdbook#installation]: https://github.com/rust-lang-nursery/mdBook#installation\n  [open an issue on GitHub]: https://github.com/OpenRA/book/issues/new\n  [open pull requests]: https://github.com/OpenRA/book/pulls","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenra%2Fbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenra%2Fbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenra%2Fbook/lists"}