From 730b17752ab28cec088b16905ff5549ca96927b3 Mon Sep 17 00:00:00 2001 From: minjaesong Date: Sat, 3 Sep 2022 23:43:20 +0900 Subject: [PATCH] updated README.md --- README.md | 78 ++++++++++++++----------------------------------------- 1 file changed, 20 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 6dde0a332..5d9f66f07 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,33 @@ ## Aperçu ## -This project is to create a side-view flatformer game, an attempt to create friendlier *Dwarf Fortress* adventurer mode, with more rogue-like stuff such as permanent death, randomness and *lots of fun*. +This project is to create a modular game engine that accommodates a 2D side-scrolling tilemap platformer, and a game that runs on top of it. -Backend used is LWJGL/Slick2D, frontend — the Engine — is custom-built. The repository contains both frontend and the actual game, as well as documentation for the backends. +The project is divided into two parts: **Terrarum the Game Engine** and **Terrarum the actual game**. -This project mainly uses Kotlin as a main language and Python/Lua for tools. +## Terrarum the Game Engine ## -Documentations and resources for work (such as .psd) are also included in the repository. You will need Mac computer to read and edit documentations in .gcx and .numbers format. (we're planning to change them) +This game engine aims to provide following features: -Any contribution in this project must be made sorely in English, Korean part is just there for my Korean friend; so be sure to use English in codes, comments, etc. +- Tiled lighting simulation with transmittance sim in full RGB and UV for fluorescence +- Corner Occlusion +- 2D Skeletal Sprite +- Built-in Mod support +- Simple AABB Physics +- Fluid simulation based on Cellular Automata +- Built-in multilingual font — please refer to [its own Repository](https://github.com/curioustorvald/Terrarum-sans-bitmap) + +## Terrarum the Actual Game ## + +*Terrarum* is a side-view tilemap platformer-adventure-sandbox game. ## Setup ## -* Requirements: - - JDK 8 or higher - - Working copy of IntelliJ IDEA from JetBrains s.r.o., community edition is okay to use. - -* Required libraries are included in the repository. - - -## The Engine ## - -Please refer to [```THE_ENGINE.md```](THE_ENGINE.md). - - -## Contribution guidelines ## - -Please refer to [```CONTRIBUTING.md```](CONTRIBUTING.md). - -## Who do I talk to? ## - -* Repo owner or admin -* Other community or team contact - - -## Tags ## - -* Rogue-like -* Adventure -* Procedural Generation -* Open World -* Sandbox -* Survival -* (Crafting) -* 2D -* Singleplayer -* Platformer -* (Atmospheric) -* Indie -* Pixel Graphics - - -## Disclaim ## - -Just in case, use this software at your own risk. +- Requirements: + - JDK 17 or higher + - IntelliJ IDEA Community Edition +Required libraries are included in the repository. ## Copyright ## -Please refer to [```COPYING.md```](COPYING.md). - -## 개요 ## - -이 변변한 이름 없는 프로젝트는 사이드뷰 발판 게임 형식으로 더 친절한 〈드워프 포트리스〉의 모험가 모드를 지향하는 게임 제작 프로젝트입니다. 영구 사망, 무작위성, __넘쳐나는 재미__와 같이 ‘로그라이크’스러운 요소를 지닙니다. - -이 프로젝트는 주 언어로 코틀린을 사용하며 파이선·루아 등으로 작성된 툴을 이용합니다. - -개발 문서와 작업용 리소스(psd 등) 또한 이 저장소에 포함되어 있습니다. gcx와 numbers 형식으로 된 문서를 읽고 수정하기 위해 맥 컴퓨터가 필요할 수 있습니다. - -이 프로젝트에 대한 기여는 영어로 이루어져야 합니다. 따라서 코드나 주석 등을 작성할 때는 영어를 사용해 주십시오. +Please refer to [```COPYING.md```](COPYING.md) but it's mostly GPL 3.