Code Monkey home page Code Monkey logo

permafrost-engine's Introduction

Logo

Permafrost Engine is an OpenGL 3.3 Real Time Strategy game engine written in C. It is made in the image of old classics, but incorporating some modern ideas.

Engine Showcase

everglory-banner

EVERGLORY is the flagship game developed using Permafrost Engine.

Support the project - Wishlist on Steam today!

village lone-warrior gather-1 gather-2 army building battle puzzle main-menu editor

Engine Summary

  • OpenGL 3.3 programmable pipeline (more modern extensions used where available)
  • Custom ASCII model format with Blender export script
  • Skeletal animation with GPU skinning
  • Phong reflection model with materials
  • Directional light shadow mapping
  • Batched rendering with dynamic batches
  • Ringbuffer-based streaming of data to GPU
  • RTS camera, FPS camera
  • Rendering of tile-based map parsed from ASCII file
  • Water rendering (including reflection, refraction, soft edge effects)
  • Export/Import of game entites to/from ASCII files
  • Engine internals exposed to Python 2.7 for scripting
  • Event system
  • UI framework (Nuklear-based)
  • Efficient raycasting
  • Map/Scene editor
  • Pause/Resume system
  • Fast rendering of huge maps
  • Map navigation graph/grid generation
  • Implementation of 'boids' steering/flocking behaviours
  • Hierarchial flow field pathfinding
  • Handling of dynamic obstacles in pathfinding
  • Dynamic collision avoidance of multiple entities using Hybrid Reciprocal Velocity Obstacles and the ClearPath algorithm
  • Efficient spatial indexing using a quadtree
  • RTS minimap
  • RTS-style unit selection
  • RTS unit combat system
  • RTS fog-of-war system
  • RTS base-building mechanics
  • RTS resource gathering (and transporting) mechanics
  • Support for different resolutions and aspect ratios
  • Configurable graphics settings
  • Serialization and deserialization of the entire Python interpreter state
  • Saving and restoring of any engine session, including all Python-defined state
  • Multithreaded: simulation and rendering in a 2-stage pipeline
  • Advanced debug visualizations and profiling instrumentatation
  • Fiber system for putting work in lightweight tasks that are scheduled in userspace
  • Fiber-backed Python tasks, allowing cooperative multitasking logic in Python
  • Cross-platform (Linux and Windows)

Dependencies

  • SDL2 2.0.10
  • GLEW 2.1.0
  • python 2.7.17
  • stb_image.h, stb_image_resize.h
  • khash.h
  • nuklear.h

All dependencies can be built from source and distributed along with the game binary if desired. Python is built with a subset of the default modules and packaged with a trimmed-down stdlib.

Building Permafrost Engine

For Linux

  1. git clone https://github.com/eduard-permyakov/permafrost-engine.git
  2. cd permafrost-engine
  3. make deps (to build the shared library dependencies to ./lib)
  4. make pf

Now you can invoke make run to launch the demo or make run_editor to launch the map editor. Optionally, invoke make launchers to create the ./demo and ./editor binaries which don't require any arguments.

For Windows

The source code can be built using the mingw-w64 cross-compilation toolchain (http://mingw-w64.org/doku.php) using largely the same steps as for Linux. Passing PLAT=WINDOWS to the make environment is the only required change.

The compliation can either be done on a Linux host, or natively on Windows using MSYS2 (https://www.msys2.org/).

  1. git clone https://github.com/eduard-permyakov/permafrost-engine.git
  2. cd permafrost-engine
  3. make deps PLAT=WINDOWS
  4. make pf PLAT=WINDOWS
  5. make launchers PLAT=WINDOWS

License

Permafrost Engine is licensed under the GPLv3, with a special linking exception.

Devlog

Follow the development of Permafrost Engine and EVERGLORY on YouTube: Channel Link

Indie RTS Devlog #1: Introducing Permafrost Engine

Indie RTS Devlog #2: Saving The Python Interpreter

Indie RTS Devlog #3: Group Pathfinding

EVERGLORY: Teaser Trailer #1

Indie RTS Devlog #4: Fog of War

Indie RTS Devlog #5: Performance Optimization

Indie RTS Devlog #6: Fibers, Async Jobs

Indie RTS Devlog #7: Main Menu UI, Loading Missions

Indie RTS Devlog #8: Python Tasks + Making Pong!

Indie RTS Devlog #9: Base Building

Indie RTS Devlog #10: Demo Gameplay

Indie RTS Devlog #11: Resource Gathering, Game Design

Comments/Questions

Comments or questions regarding the project or the source code? E-mail: [email protected]. Discuss EVERGLORY and its' development on Discord here: https://discord.gg/jSQ8M6C. Pull requests are not accepted until the release of EVERGLORY, which will coincide with the 1.0 milestone of the engine.

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.