Skip to content

Latest commit

 

History

History
106 lines (78 loc) · 6.23 KB

README.md

File metadata and controls

106 lines (78 loc) · 6.23 KB
Raw

SharpQuake

GitHub license PRs Welcome

Description

SharpQuake is a GLQuake reimplementation in C# using the OpenTK library and the .NET Core platform.

Roadmap

  • Code cleanup:

    • Change Init / Shutdown pattern for IDisposable pattern (Ongoing)
    • Move type definitions out of core code and into a Framework library (Ongoing)
    • Use PascalCase for properties, fields, function names, class names & structs (Ongoing)
    • Use inheritance and polymorphism where classes handle multiple object types (Ongoing)
    • Use camelCase for local variables (Ongoing)
    • Rename type definitions to .NET style variations (Ongoing)
    • Support for external map textures (Ongoing)
    • Adapt mesh routines to use Vertex and Index buffers
    • Refactor into a structure similar to Quake 3 (cgame, game, quake3, ui)
    • Add 16:9, 16:10 and 21:9 support
    • Add PK3 (ZIP) support
    • Convert static classes to instance classes where static is unnecessarily used
    • Remove code duplication via file loading and handling in many non-filesystem related classes
    • Abstract OpenGL code from core engine code

  • Features planned:

    • Port geometry rendering to a GLSL shading system
    • Implement central messaging system like those in engines like idtech3 and idtech4
    • Add support for Quake 3 BSPs and potentially Quake 3 shaders
    • Upgrade lighting system/introduce Normal Map and specular map support
    • Add support for MD3 and more modern model formats
    • Develop configurable UI system (Similar to FAKK2/MOHAA)

  • Maybe if we're lucky (Would be nice):

    • Port q3map compiler to C# .NET (Why? Why not?)
    • Implement PBR and custom BSP format (With light mapping like Bakery - GPU Lightmapper for Unity)

  • Please take a look into this

Dependencies

  • OpenTK 3.3.1
  • NVorbis 0.10.5
  • .NET 6
  • OpenAL (Windows) / libopenal on Linux
  • SDL2 (Windows and macOS) / libsdl2-2.0 on Linux (Runtime binaries)

Building

Project is built against and tested for Visual Studio 2019 on .NET Core 3.1

  1. Install these nuget packages

    • Install-Package OpenTK -Version 3.3.1
    • Install-Package NVorbis -Version 0.10.5
    • Install-Package NVorbis.OpenTKSupport -Version 1.4.0
    • Update-Package –reinstall

  2. Initialize git submodules

  3. Add dependencies for your target architecture in your output directory (defaults to <project root>/Quake).

    • See links under dependencies header above

  4. Add ld1, hipnotic, and rogue (minimum ld1) data directories to <project root>/Quake.

    • You only need the <mod>\pak0.pak, etc. and <mod>\config.cfg files of each directory if copying from a steam install.

  5. Build solution.

Running

In case you don't own a copy of Quake you can purchase it on GOG.com, Steam or use the shareware version.

As Linux is case-sensitive make sure your folder and file names look like that Id1 and PAK0.PAK and PAK1.PAK (in case you own the full version).

To play with soundtrack add it to Id1/music or the mission pack folder you want to play in OGG Vorbis format like this track02.ogg. You can get it here Steam Guide

macOS / OSX is not official supported as OpenGL on Mac is poorly supported and has been replaced in favour of their own graphics API Metal.

The -basedir <directory> switch can be used to change the default data directory. e.g. SharpQuake.exe -basedir C:\Quake\

-window switch is pre-defined in project settings, but if you change the default directory of where you want your data, you may need to add -basedir <directory> to project properties > Debug > Command line arguments

The original expansion packs can be run using -rogue or -hipnotic switches if the data is present for it.

Original Quake switches apply and can be used.

Enjoy! 🙂

Screenshot

Credits