sleepy-launcher/README.md

75 lines
3.6 KiB
Markdown
Raw Normal View History

| Modern style | Classic style |
| :-: | :-: |
| <picture><source media="(prefers-color-scheme: dark)" srcset="repository/main-modern-dark.png"><img src="repository/main-modern.png"></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="repository/main-classic-dark.png"><img src="repository/main-classic.png"></picture> |
| <picture><source media="(prefers-color-scheme: dark)" srcset="repository/settings-modern-dark.png"><img src="repository/settings-modern.png"></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="repository/settings-classic-dark.png"><img src="repository/settings-classic.png"></picture> |
2023-03-16 00:14:08 +03:00
<p align="center">
<a href="https://discord.gg/ck37X6UWBp">Discord</a> ·
2024-07-04 09:17:28 +03:00
<a href="https://github.com/an-anime-team/sleepy-launcher/wiki">Wiki</a>
2023-03-16 00:14:08 +03:00
</p>
2023-03-16 00:14:08 +03:00
<br>
2023-04-21 22:11:40 +03:00
# ♥️ Useful links and thanks
2023-04-21 22:11:40 +03:00
* [macOS launcher](https://github.com/3Shain/yet-another-anime-game-launcher) which contains some additional compatibility components
2024-07-04 09:17:28 +03:00
* [Wiki](https://github.com/an-anime-team/sleepy-launcher/wiki) contains some basic FAQ, installation instructions and more
* [Releases page](https://github.com/an-anime-team/sleepy-launcher/releases) where you can find latest available version
2023-04-21 22:11:40 +03:00
* [Changelog](CHANGELOG.md) with chronology of the project
<br>
2023-04-21 22:11:40 +03:00
# ⬇️ Download
| Distribution | Format | Wiki | Source |
| - | - | - | - |
2024-07-04 09:17:28 +03:00
| Fedora | Flatpak | [link](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-any-distribution-flatpak) | - |
| Arch Linux, Manjaro | AUR | [link](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-arch-linux-aur) | [sleepy-launcher-bin](https://aur.archlinux.org/packages/sleepy-launcher-bin) |
| Fedora, OpenSUSE | RPM | [link](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-fedora-rpm) | [AAGL](https://build.opensuse.org/repositories/home:Maroxy:AAT-Apps/AAGL) |
| Ubuntu | pacstall | - | [sleepy-launcher-bin](https://pacstall.dev/packages/sleepy-launcher-bin) |
| Gentoo | ebuild | [link](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-gentoo-linux-ebuild) | [aagl-ebuilds](https://github.com/an-anime-team/gentoo-ebuilds) |
| NixOS | nixpkg | [link](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-nixos-nixpkg) | [aagl-gtk-on-nix](https://github.com/ezKEa/aagl-gtk-on-nix) |
2024-07-04 09:17:28 +03:00
To see the installation guides, please visit the wiki page [here](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation)
2024-07-04 09:17:28 +03:00
Lutris integration described [here](https://github.com/an-anime-team/sleepy-launcher/wiki/Installation#-lutris)
## Chinese version support
2023-04-21 22:11:40 +03:00
This should be automatically enabled if you're using zh_cn (Chinese) as your system language. If you're not using it - you can change the game edition in the launcher settings
2022-08-24 22:06:03 +03:00
<br>
2023-04-21 22:11:40 +03:00
# 💻 Development
2022-06-29 00:59:20 +03:00
| Folder | Description |
| - | - |
| src | Rust source code |
2023-01-18 19:38:12 +03:00
| assets | App assets folder |
| assets/locales | App localizations |
2022-06-29 00:59:20 +03:00
| target/release | Release build of the app |
2022-08-26 12:51:07 +03:00
## Clone repo
2022-06-29 00:59:20 +03:00
```sh
2024-07-04 09:17:28 +03:00
git clone --recursive https://github.com/an-anime-team/sleepy-launcher
2022-06-29 00:59:20 +03:00
```
2022-08-26 12:51:07 +03:00
## Run app
2022-06-29 00:59:20 +03:00
```sh
cargo run
```
2022-08-26 12:51:07 +03:00
## Build app
2022-06-29 00:59:20 +03:00
```sh
cargo build --release
```
2023-03-19 17:50:21 +03:00
## Updates strategy
2024-07-04 09:17:28 +03:00
Starting from 3.2.1 ([fcab428](https://github.com/an-anime-team/sleepy-launcher/commit/fcab428cb40b1457f41e0856f9d1e1473acbe653)) we have 2 branches: stable ([main](https://github.com/an-anime-team/sleepy-launcher/tree/main)) and dev ([next](https://github.com/an-anime-team/sleepy-launcher/tree/next)). Code changes will be pushed into dev branch and merged into stable once they're ready for new version release
2023-03-19 17:50:21 +03:00
2023-03-19 18:03:59 +03:00
<img src="repository/branches.png" />