{"id":13580874,"url":"https://github.com/cormac-obrien/richter","last_synced_at":"2025-04-06T06:32:10.146Z","repository":{"id":46220307,"uuid":"63914371","full_name":"cormac-obrien/richter","owner":"cormac-obrien","description":"A modern Quake engine.","archived":false,"fork":false,"pushed_at":"2024-11-09T00:11:27.000Z","size":2939,"stargazers_count":551,"open_issues_count":14,"forks_count":34,"subscribers_count":21,"default_branch":"devel","last_synced_at":"2025-04-04T01:44:24.390Z","etag":null,"topics":["fps","fps-engine","quake","quake-engine","retro","rust"],"latest_commit_sha":null,"homepage":"http://c-obrien.org/richter/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cormac-obrien.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-22T01:40:12.000Z","updated_at":"2025-04-03T10:11:59.000Z","dependencies_parsed_at":"2023-01-18T04:00:22.471Z","dependency_job_id":null,"html_url":"https://github.com/cormac-obrien/richter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cormac-obrien%2Frichter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cormac-obrien%2Frichter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cormac-obrien%2Frichter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cormac-obrien%2Frichter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cormac-obrien","download_url":"https://codeload.github.com/cormac-obrien/richter/tar.gz/refs/heads/devel","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445649,"owners_count":20939952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["fps","fps-engine","quake","quake-engine","retro","rust"],"created_at":"2024-08-01T15:01:55.882Z","updated_at":"2025-04-06T06:32:09.704Z","avatar_url":"https://github.com/cormac-obrien.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Richter\n\n[![Build Status](https://travis-ci.org/cormac-obrien/richter.svg?branch=devel)](https://travis-ci.org/cormac-obrien/richter)\n\nA modern implementation of the Quake engine in Rust.\n\n![alt tag](https://i.imgur.com/25nOENn.png)\n\n## Status\n\nRichter is in pre-alpha development, so it's still under heavy construction.\nHowever, the client is nearly alpha-ready -- check out the Client section below to see progress.\n\n### Client\n\nThe client is capable of connecting to and playing on original Quake servers using `sv_protocol 15`.\nTo connect to a Quake server, run\n\n```\n$ cargo run --release --bin quake-client -- --connect \u003cserver_ip\u003e:\u003cserver_port\u003e\n```\n\nQuake servers run on port 26000 by default.\nI can guarantee compatibility with FitzQuake and its derived engines, as I use the QuakeSpasm server for development (just remember `sv_protocol 15`).\n\nThe client also supports demo playback using the `--demo` option:\n\n```\n$ cargo run --release --bin quake-client -- --demo \u003cdemo_file\u003e\n```\n\nThis works for demos in the PAK archives (e.g. `demo1.dem`) or any demos you happen to have placed in the `id1` directory.\n\n#### Feature checklist\n\n- Networking\n  - [x] NetQuake network protocol implementation (`sv_protocol 15`)\n    - [x] Connection protocol implemented\n    - [x] All in-game server commands handled\n    - [x] Carryover between levels\n  - [ ] FitzQuake extended protocol support (`sv_protocol 666`)\n- Rendering\n  - [x] Deferred dynamic lighting\n  - [x] Particle effects\n  - Brush model (`.bsp`) rendering\n    - Textures\n      - [x] Static textures\n      - [x] Animated textures\n      - [x] Alternate animated textures\n      - [x] Liquid texture warping\n      - [ ] Sky texture scrolling (currently partial support)\n    - [x] Lightmaps\n    - [x] Occlusion culling\n  - Alias model (`.mdl`) rendering\n    - [x] Keyframe animation\n      - [x] Static keyframes\n      - [x] Animated keyframes\n    - [ ] Keyframe interpolation\n    - [ ] Ambient lighting\n    - [ ] Viewmodel rendering\n  - UI\n    - [x] Console\n    - [x] HUD\n    - [x] Level intermissions\n    - [ ] On-screen messages\n    - [ ] Menus\n- Sound\n  - [x] Loading and playback\n  - [x] Entity sound\n  - [ ] Ambient sound\n  - [x] Spatial attenuation\n  - [ ] Stereo spatialization\n  - [x] Music\n- Console\n  - [x] Line editing\n  - [x] History browsing\n  - [x] Cvar modification\n  - [x] Command execution\n  - [x] Quake script file execution\n- Demos\n  - [x] Demo playback\n  - [ ] Demo recording\n- File formats\n  - [x] BSP loader\n  - [x] MDL loader\n  - [x] SPR loader\n  - [x] PAK archive extraction\n  - [x] WAD archive extraction\n\n### Server\n\nThe Richter server is still in its early stages, so there's no checklist here yet.\nHowever, you can still check out the QuakeC bytecode VM in the [`progs` module](https://github.com/cormac-obrien/richter/blob/devel/src/server/progs/mod.rs).\n\n## Building\n\nRichter makes use of feature gates and compiler plugins, which means you'll need a nightly build of\n`rustc`. The simplest way to do this is to download [rustup](https://www.rustup.rs/) and follow the\ndirections.\n\nBecause a Quake distribution contains multiple binaries, this software is packaged as a Cargo\nlibrary project. The source files for binaries are located in the `src/bin` directory and can be run\nwith\n\n    $ cargo run --bin \u003cname\u003e\n\nwhere `\u003cname\u003e` is the name of the source file without the `.rs` extension.\n\n## Legal\n\nThis software is released under the terms of the MIT License (see LICENSE.txt).\n\nThis project is in no way affiliated with id Software LLC, Bethesda Softworks LLC, or ZeniMax Media\nInc. Information regarding the Quake trademark can be found at Bethesda's [legal information\npage](https://bethesda.net/en/document/legal-information).\n\nDue to licensing restrictions, the data files necessary to run Quake cannot be distributed with this\npackage. `pak0.pak`, which contains the files for the first episode (\"shareware Quake\"), can be\nretrieved from id's FTP server at `ftp://ftp.idsoftware.com/idstuff/quake`. The full game can be\npurchased from a number of retailers including Steam and GOG.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcormac-obrien%2Frichter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcormac-obrien%2Frichter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcormac-obrien%2Frichter/lists"}