Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tredfern/terminus

Roguelike game built using Lua/Love2D/Moonpie
https://github.com/tredfern/terminus

games love2d lua roguelike rpg

Last synced: 2 months ago
JSON representation

Roguelike game built using Lua/Love2D/Moonpie

Awesome Lists containing this project

README 

        
![Build Status](https://github.com/tredfern/terminus/actions/workflows/build.yml/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/tredfern/terminus/badge.svg?branch=main)](https://coveralls.io/github/tredfern/terminus?branch=main)

[![GitHub milestone](https://img.shields.io/github/milestones/progress-percent/tredfern/terminus/3)](https://github.com/tredfern/terminus/milestone/3)

[![Love2D Version](https://img.shields.io/badge/love2d-11.3-pink.svg)](https://love2d.org)



# Terminus



Develop a game that combines my _learnings of systems thinking_, _opinions on software engineering_, and _love for games that give control to the player to influence the world_.



## Goals

### Fun

The game should be fun to play. That fun should come from the combination of challenge and discovery.



### 99% Unit Test Coverage

A strange goal perhaps. I believe that TDD can assist any project. Because of the planned complexity of interactions between entities, unit tests will provide a foundation to validate those interactions and potentially test balance.



### Easy to Mod

The game should feel like a framework that could be extended. Similar to creating an RPG system where the adventures, items and characters can be created by anyone.



### High Replay Value

The game should have either different challenges or feel so different every time that it encourages people to play again.



### A Feeling of Story

The game should have a feeling that a story is occurring and the player is contributing to the creation of that story.



## Development



[**Weekly Blog Posts**](https://wheretheredfern.codes) giving a brief overview of the code changes implemented and screenshots of progress.



[**Live Coding on Twitch**](https://twitch.tv/wheretheredferncodes)

Saturdays & Sundays 13:00-15:00 EST.



[**Milestone Progress**](https://github.com/tredfern/terminus/milestones) will track significant changes and progress.



[**Builds / Releases**](https://github.com/tredfern/terminus/releases) will be automatically created for every tagged push.



## Concept



An RPG based game/system set in a sci-fi universe. Player is one of a small group of soldiers that

awakens on a ship/space station/moon base to a major disaster in progress. Player needs to navigate rogue robots and 

damaged systems to repair the ship to save the rest of the crew. 



Play styles could vary between more combat expertise, which will increase survivability but might limit exploration

or other skill opportunities. Or maybe using more survival skills which will help with finding supplies and

alternate routes. Or maybe a more skill focus that allows the character more abilities to explore and solve problems.



## Theme / Setting



_Survival Theme: The hero desire to keep taking a step forward even when facing overwhelming odds just to survive._



Potential deeper themes:

* When society is collapsing, what is the balance between preserving ourselves and preserving the people around us?

* Turn-based game that allows the player time to think and choose actions

* However, action-based game would allow the chaos of the situation to feel more present



## Inspiration



I'm focusing my inspiration on games from the past. Certainly there will be ideas that will leverage current games including things like Dwarf Fortress/Rimworld or Caves of Qud, or Fall Guys (inspiration can and should come from anywhere). These old games captured my mind when I started playing them and finding what made that spark happen is what I'm curious about exploring with this project.



**[The Magic Candle](https://en.wikipedia.org/wiki/The_Magic_Candle)** - I played this game when it first came out in 1989. It has been a while since I last played it, but I remember being impressed by the mechanics of exploration. This game felt huge. And also the ways that you managed your party. 



**[Darklands](https://en.wikipedia.org/wiki/Darklands_%28video_game%29)** - A very interesting RPG that allowed a lot of freedom in how you approached the game. But one of my favorite features was that you didn't have to move your character through each individual square when walking through a town. How much time did I waste in most RPG's just clicking from one side of the map to another just to complete a quest? Being able to navigate to locations was fantastic.



**[Ultima V](https://en.wikipedia.org/wiki/Ultima_V%3A_Warriors_of_Destiny)** - The main Ultima game I played. I loved the variety of towns and quests that linked things together. Getting the magic carpet, was awesome. 



**[Everything Epyx](https://en.wikipedia.org/wiki/Epyx)** - I grew up looking at everything Epyx released. I loved their motto even as a kid of combining strategy with action. Some of their games that are influencing my thinking on this project are, Temple of Apshai Trilogy, Dragonriders of Pern (I'm serious, I played that game a ton),



An interesting tidbit I learned from research is that Epyx did the port of Rogue to non-Unix platforms.



**[Force 7](https://www.mobygames.com/game/c64/force-7)** - There was this game on the C64 where you had a crew and needed to eliminate all these aliens in various rooms.



**[Cogmind](https://www.gridsagegames.com/cogmind/)** - similar genre and also sci-fi. Different play styles available and need to keep alert level down.



**[Dungeon of the Endless](https://www.mergegames.com/dungeon-of-the-endless)** - Random generated dungeon of rooms where you are trying to get to the top level



**[Rimworld](https://rimworldgame.com/)** - If the game evolves into more of a base-building mechanic



**[Shadowgrounds](https://shadowgroundsgame.com/)** - Aliens attacking a base and working through levels to solve/protect it



**[Metamorphisis Alpha](https://www.drivethrurpg.com/product/58985/Metamorphosis-Alpha-4th-Edition)** - Never played this, but the general story is similar and a strong basis for inspiration.



**[Traveller](https://en.wikipedia.org/wiki/Traveller_%28role-playing_game%29)** - Never played this, character design is interesting. Generally seen as a very open-ended RPG system in a sci-fi world that can help inspire how to face certain design decisions for the underlying mechanics.



#### Books / Movies

_Orphans in the Sky_ - I read this book as a child and remember it still. 



_Aliens_ - Both from Newt's survival session on her own to the marines fighting their way in



_Diehard_ - Facing off against an invading force on your own. Identifying your enemy and their intentions



_Lost in Space_ - Traveling to a new world, a catastrophe happens and people band together to survive



## Game Design Documentation

Design documentation for the game can be found in the [docs folder of the repo](/docs). This will outline any milestones,

project plans, different design considerations or other information about the game.



## Framework



This project depends on the [Moonpie](https://github.com/tredfern/moonpie) framework for [Love2D](https://love2d.org).

This framework is designed to organize code into clear separation of responsibilities. This allows for the ability

to create unit tests efficiently for any point of the system that can benefit from testing.



The key pieces of the framework are the `store` and `ui.components`. The `ui.components` provide an easy way to define

the UI in a responsive way. Making it easy to layout the style and various controls necessary for displaying and

receiving user input. The `store` manages the game state and all the information happening in the game.



Both of these patterns are similar in spirit to [React-Redux](https://react-redux.js.org/). By isolating state and

making sure all updates are coordinated through actions and reducers, we can easily control state changes and centralize

the updates.



## Project Organization



The project is organized around the concept of `rules`. Rules represent some either complex interactions or entity in

the game. For example, currently there is a `character` rule section, and a `combat` rule section. Each with it's own

concerns. Within any rules domain, there can be `actions` which can be dispatched to the store, `selectors` which

retrieve values from state, or any other `custom` functionality that makes the most sense for this section of the rules.



By separating into various section, each rules area can control a section of state. If any other rules area wants to

modify another rules state section, it dispatches the appropriate action to the other rule for those to be handle.



#### An Example



Characters manage the various bits of information like, how much health do I have, what is my name, what team am I on, etc...

Combat manages the interaction between potentially characters, but could be other entities as well. But has no

state of it's own that it manages.



When a character `attacks` another character. A combat action is dispatched to resolve the attack and encapsulate all

the rules about how combat is resolved. The combat might need to check-in with the `skills` rules and to figure out

how some competing skill checks get resolved. Depending on that resolution it will dispatch updates to the character

that some damage has occurred, or some ammunition is consumed, etc...



## Contributing / Building from Source



Terminus runs in Love2D and you will need to download the appropriate version for your system first - [Download Love2D](https://love2d.org/).

```

$ git clone [email protected]:tredfern/terminus.git

$ cd terminus

$ git submodule update --init

$ path/to/love .

```