Giter VIP home page Giter VIP logo

antiquake-rs's Introduction

Antiquake Engine

Build Status

project board

An indie games engine based off of the quake framework implemented in Rust. Forked from richter by cormac-obrien.

  • Antiquake will always support entry-level graphics hardware including Intel Mesa/integrated graphics drivers and linux.
  • Antiquake will only require a maximum of 128 push constants for a GPU which is the typical min spec.
  • Antiquake does not depend on python or c++ it is a pure rust implementation using wgpu and naga for graphics

Levels can be designed using Trenchbroom editor.

alt tag

STEPS TO RUN

boot with this: cargo run --bin quake-client type in console: playdemo demo1

// connect to https://www.quakeservers.net/quake/servers/ ?

Status

Antiquake is in pre-alpha.

Client

The client is capable of connecting to and playing on original Quake servers using sv_protocol 15. (hint: shortcut with ../../../quakespasm.exe -dedicated 16 -port 26000 -map e1m1 -protocol 15)

To connect to a Quake server, run

$ cargo run --release --bin quake-client -- --connect <server_ip>:<server_port>

Quake servers run on port 26000 by default. I can guarantee compatibility with FitzQuake and its derived engines, as I use the QuakeSpasm server for development (just remember sv_protocol 15).

hint: connect 127.0.0.1:26000

The client also supports demo playback using the --demo option:

$ cargo run --release --bin quake-client -- --demo <demo_file>

This works for demos in the PAK archives (e.g. demo1.dem) or any demos you happen to have placed in the id1 directory.

https://www.gamers.org/dEngine/quake/QDP/qnp.html#connection_req

Feature checklist

  • Networking
    • NetQuake network protocol implementation (sv_protocol 15)
      • Connection protocol implemented
      • All in-game server commands handled
      • Carryover between levels
    • FitzQuake extended protocol support (sv_protocol 666)
  • Rendering
    • Deferred dynamic lighting
    • Particle effects
    • Brush model (.bsp) rendering
      • Textures
        • Static textures
        • Animated textures
        • Alternate animated textures
        • Liquid texture warping
        • Sky texture scrolling (currently partial support)
      • Lightmaps
      • Occlusion culling
    • Alias model (.mdl) rendering
      • Keyframe animation
        • Static keyframes
        • Animated keyframes
      • Keyframe interpolation
      • Ambient lighting
      • Viewmodel rendering
    • UI
      • Console
      • HUD
      • Level intermissions
      • On-screen messages
      • Menus
  • Sound
    • Loading and playback
    • Entity sound
    • Ambient sound
    • Spatial attenuation
    • Stereo spatialization
    • Music
  • Console
    • Line editing
    • History browsing
    • Cvar modification
    • Command execution
    • Quake script file execution
  • Demos
    • Demo playback
    • Demo recording
  • File formats
    • BSP loader
    • MDL loader
    • SPR loader
    • PAK archive extraction
    • WAD archive extraction

Server

The server is still in its early stages, so there's no checklist here yet. However, you can still check out the QuakeC bytecode VM in the progs module.

Building

Antiquake makes use of feature gates and compiler plugins, which means you'll need a nightly build of rustc. The simplest way to do this is to download rustup and follow the directions.

Because a Quake distribution contains multiple binaries, this software is packaged as a Cargo library project. The source files for binaries are located in the src/bin directory and can be run with

$ cargo run --bin <name>

where <name> is the name of the source file without the .rs extension.

Legal

This software is released under the terms of the MIT License (see LICENSE.txt).

This project is in no way affiliated with id Software LLC, Bethesda Softworks LLC, or ZeniMax Media Inc. Information regarding the Quake trademark can be found at Bethesda's legal information page.

Due to licensing restrictions, the data files necessary to run Quake cannot be distributed with this package. pak0.pak, which contains the files for the first episode ("shareware Quake"), can be retrieved from id's FTP server at ftp://ftp.idsoftware.com/idstuff/quake. The full game can be purchased from a number of retailers including Steam and GOG.

antiquake-rs's People

Contributors

cormac-obrien avatar antiquakerust avatar ethereumdegen avatar bors[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.