https://github.com/unknownrori/kurai-project

Kurai Project is an open source fan-game set in world of Touhou Project (Currently in Development)
https://github.com/unknownrori/kurai-project

game macroquad rust-lang shmup touhou

Last synced: about 4 hours ago
JSON representation

Kurai Project is an open source fan-game set in world of Touhou Project (Currently in Development)

• Host: GitHub
• URL: https://github.com/unknownrori/kurai-project
• Owner: UnknownRori
• License: other
• Created: 2024-01-13T08:41:17.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-13T04:44:56.000Z (7 months ago)
• Last Synced: 2024-04-13T18:13:52.207Z (7 months ago)
• Topics: game, macroquad, rust-lang, shmup, touhou
• Language: Rust
• Homepage: https://unknownrori.github.io/kurai-project/
• Size: 21.7 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kurai Project










 [ 
 Install 
 ](#installation) 

 [ 
 Development 
 ](#development) 







## Introduction

Kurai Project is an open source fan-game set in world of [Touhou Project](https://en.wikipedia.org/wiki/Touhou_Project).

It is top-down vertical-scrolling curtain of fire shooting game (STG) also known as "Bullet hell" or "Danmaku".

STGs are fast-paced games focused around pattern recognition and mastery through practice.

Kurai Project is somewhat portable, and it's written in Rust, 

the portability comes from [macroquad](https://github.com/not-fl3/macroquad) crate for handling file and rendering, 

it support OpenGL, Metal, GLES rendering and also WebGL for browser such as Firefox and Chromium based browser, 

it can be compiled for number of operating system.

### About Touhou Project

Touhou Project is an indie game series (also known as "doujin" in Japanese)

known for its ensemble cast of characters and memorable soundtracks.

It is produced by and large by a single artist known as ZUN, and has a

[permissive license](https://en.touhouwiki.net/wiki/Touhou_Wiki:Copyrights#Copyright_status.2FTerms_of_Use_of_the_Touhou_Project>)

which allows for indie derivative works such as Kurai Project to legally exist.

Kurai Project is *not* a "clone" of Touhou Project, and tells an original story with its own

music, art, gameplay mechanics, and codebase. While some familiarity with Touhou

is helpful, the gameplay can be enjoyed on its own without prior knowledge of

the series.

For more information on dōjin culture,

[click here](https://en.wikipedia.org/wiki/D%C5%8Djin).

## Installation

### System Requirement

----------------------------------------

| Component |   Minimum  | Recommended |

|-----------|------------|-------------|

|    CPU    |   2.0 Ghz  |   2.0 Ghz   |

|    RAM    |   300 Mb   |   500 Mb    |

|    GPU    |    1 Gb    |  > 1.0 Gb   |

* The requirement might change over the course of development

> [!WARNING]

> Pre-compiled is not yet available, you can install it via `cargo install` or `cargo build`

## Development

Make sure you already installed Rust at minimum 1.75 because I might be using latest Rust feature

```sh

# Clone repository and enter to cloned directory

git clone https://github.com/UnknownRori/scarlet-project

cd scarlet-project

# Run the game

cargo run

```