Giter VIP home page Giter VIP logo

townly's Introduction

Townly

CLI city building game inspired by TheoTown and Cities: Skylines

Powered by Teng


If you have questions or wanna chat, feel free to join my Discord server



Download:

If you want to download and play this game, please check out the #builds channel on the Townly Discord server.



Why?

Good question. Let me just make up some totally legitimate reasons, hold on...

I challenged myself multiple times to create games in the Command Line Interface.
The goal was for me to be able to play the games on my server via SSH.
This is my biggest challenge yet, a fully fledged city building game that runs in the command line.

You can find my other CLI games here.



The story behind Townly:

Initial vanilla JS version:

Townly was first made in pure Node.js because I couldn't get my Qt Creator to work on my PC for a whole year.
The legacy JS version's code can be found here.


C++ Rewrite:

After 2 months of work I started rewriting it in C++ (with Qt).
The thought behind the rewrite was native compilation to executables, more stability and performance and lower-level access to the system.
The legacy C++ version's code can be found here.


TypeScript Rewrite:

Two months later I quickly burnt out because C++ is fucking difficult (who would've thought).
So after about a month of pause, I decided to go with the best of both worlds and rewrote it again, but in TypeScript.
It offers both the quick and easy coding of JavaScript and the type safety and extensive features of a language like C++.
I also wanted to separate the game and the engine so that I can eventually reuse the engine or publish it separately.
More info on the engine can be found here.



Some helpful resources:





Build Instructions:

If you can't find a compatible version of Townly, you can follow this guide to build Townly:

First, make sure you have Git, Node.js, npm and TypeScript set up and working, then:

  1. Clone the repository
  2. Pull the Teng submodule by running git submodule init and then git submodule update
  3. Install dependencies by running npm i
  4. Run the command npm start to compile and run the code
  • To create an executable, use the command npm run compile-pkg





townly's People

Contributors

imgbotapp avatar sv443 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  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.