Skip to content

Commit

Permalink
v0.6 is ready
Browse files Browse the repository at this point in the history
update README.md
  • Loading branch information
hndada committed Jul 23, 2023
1 parent 217c306 commit 25a8c0d
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 47 deletions.
76 changes: 31 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,7 @@

Classic rhythm games written in go with Ebitengine

# How to play
Change the mode with `F1`

Change the Speed with `PageUp / PageDown`

Select the song with `Enter`

Press matching keys with notes!

You can change key settings by modifying `keys.txt`. Default Key settings are below:
```
4 Key: S, D, J, K
7 Key: S, D, F, Space, J, K, L
Drum: S, D, J, K
```
Latest version: 0.6 (July 23rd, 2023)

# Game play preview
Click thumbnails to watch at YouTube.
Expand All @@ -27,61 +13,61 @@ Click thumbnails to watch at YouTube.

[![cillia - Ringo Uri no Utakata Shoujo [Ringo Oni]](https://i.imgur.com/0Ven6Oa.png)](https://youtu.be/8VgzAlc4SJ0)


# How to play
1. Select the song with `Enter`.
2. Press matching keys with notes.
3. Change the Speed with `PageUp / PageDown`

```
4 Key: S, D, J, K
7 Key: S, D, F, Space, J, K, L
```

# Feature
* osu! files supported
* .osu (osu! beatmap file)
* Speed-change effects work (called `SV`).
* .osr (osu! replay file)
* Put replay files at `replay/` with `ReplayMode` at select scene.

* Skinnable in-game images
* Put your favorite skin in `skin/` (should match the file name though).
* Image size in game are settable by user (WIP).
* You can try it right now with changing value at `settings.go` and build.

* Effective score and level system (originally designed)
* Practical score and level system
* The motivation of gosu dev.
* Tried to make feel score and actual performance are related.
* Level calculation is currently naive.
* Will be exquisite in a short time.
* WIP: Level calculation

* Customize in-game sprites
* Put your favorite skin in `asset/` with matching name.

* Quick input supported (1ms)
* *Hook* is used in `Windows`.
* Quick input listener
* WINAPI is used in `Windows`.
* Others is currently depending on `ebiten.IsKeyPressed` .

* Codebase with high readability
* Super-fast in loading files and playing.
* Fairly scalable for future work.

# Build
1. For MacOS and Linux users, install Ebitengine dependencies first by referring to the
documentation([Ebitengine/Install](https://ebitengine.org/en/documents/install.html)).

1. For MacOS and Linux users, install Ebitengine dependencies first by referring to the documentation([Ebitengine/Install](https://ebitengine.org/en/documents/install.html)).

2. Go to root directory of the repository and build as below.

2. Go to root directory of the repository and type:
```zsh
cd cmd/gosu
go build .
```

3. Run gosu

```zsh
./gosu
```

# Web version
[https://gosu-web-orcin.vercel.app](https://gosu-web-orcin.vercel.app)
Version: 0.4.1

**[https://gosu-web-orcin.vercel.app](https://gosu-web-orcin.vercel.app)**

# Flow of game logic
![Game logic](https://i.imgur.com/g5G6XLI.png)
# Game structure
### Package flow
![Game structure](https://i.imgur.com/gwFA6es.png)

### [Powerpoint and SlideShare (preview below)](https://www.slideshare.net/MuangMuangE/gosupresentpptx-253675145)
### [Introduction of gosu development](https://www.slideshare.net/MuangMuangE/gosupresentpptx-253675145)
[![gosu-present](https://i.imgur.com/rtq5n9p.png)](https://www.slideshare.net/MuangMuangE/gosupresentpptx-253675145)

Will also post details at [wiki](https://github.com/hndada/gosu/wiki).

# License
Codebase: Apache License 2.0

Most skin images and music tracks are from [osu-resources](https://github.com/ppy/osu-resources), licensed under [CC-BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/legalcode).
Most skin images and music tracks are from [osu-resources](https://github.com/ppy/osu-resources),
licensed under [CC-BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/legalcode).
4 changes: 2 additions & 2 deletions scene/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ func NewConfig() *Config {
MusicRoots: []string{"music"},
ScreenSize: screenSize,

MusicVolume: 0.30,
SoundVolume: 0.50,
MusicVolume: 0.60,
SoundVolume: 0.60,
MusicOffset: 0,
BackgroundBrightness: 0.6,
DebugPrint: true,
Expand Down

0 comments on commit 25a8c0d

Please sign in to comment.