Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kleineluka/modnamedhana

A Repurpose fan-made mod to add Hana content!
https://github.com/kleineluka/modnamedhana

hana renpy repurpose rust tauri visual-novel

Last synced: about 14 hours ago
JSON representation

A Repurpose fan-made mod to add Hana content!

Awesome Lists containing this project

README

        

# Mod Named Hana
A [Repurpose](https://residentrabbit.itch.io/repurpose) **fan-made** mod to add Hana content!

[Straight to Downloads 🌈](https://www.github.com/kleineluka/modnamedhana) â€ĸ [View Changelog 🍩](https://www.github.com/kleineluka/modnamedhana)

**Current Status:** 🚧 In Development! 🚧 ~~(.. and needing help with art or writing)~~

---

[Features đŸĨš](#features-) â€ĸ [Install đŸĒ„](#install-) â€ĸ [Guides & FAQ 😖](#guides--faq-) â€ĸ [Contribute 📝](#contribute-) â€ĸ [Credits & Licenses 🎉](#credits--licenses-)

# Features đŸĨš
- Play a fan-made path dedicated to ~~Annoying Girl~~ Hana!
- Multiple ways to engage the path, and different endings for the path.
- New stats to manage! It's not just about building friendship, but also raising Hana's trust and self-esteem.
- New sprites! I wouldn't go as far as to say "new art" because I just played around in Photoshop and I'm no artist..
- Lots of words! ~~word count coming soon..ish..~~
- Unique interactions based on your character (ex. gender)
- Expansion on the original codebase (libraries, GLSL shaders, etc.) to add some immersive effects!
- Open-source and community-driven! You are free to help.. please help..

# Install đŸĒ„
- Coming when the mod is released... please refer to the current status at the top of the page.
- You have two options to install:
- Installer **(Suggested)**: Automatically create a new game copy with the mod or patch your existing.
- Manual: Download the mod content and replace/move files yourself. **You will need a method to patch the binary diff in the resource RPA file - this is so I didn't redistribute the entire game.**

# Guides & FAQ 😖
- Walk through coming when the mod is released!

# Contribute 📝

### Writing or Art
.. need help! please reach out :) discord: `kleinezoey`

### Mod Development
- [RenPy](https://www.renpy.org/) is the game engine for Repurpose, sooo the mod is written in its scripting language. You can find more information on how to mod Repurpose [here](https://github.com/kleineluka/modnamedhana/blob/main/knowledge/Modding%20Repurpose.md).

> [!TIP]
> You can find the [mod content in /src-tauri/renpy/](https://github.com/kleineluka/modnamedhana/tree/main/src-tauri/renpy)!

### Installer Development
- [Rust](https://www.rust-lang.org/) is the back-end. Why? It's lightweight, cross-platform, and easily redistributable... ~~and I needed an excuse to learn it~~. It also provides an easy and safe way to patch byte differences in the game's resource file (to add new sprites).
- [Tauri](https://tauri.app/) is the front-end, for delivering an Electron experience without the bloat. This means that **Node** is the (other) package manager used here!

> [!TIP]
> You can find the the [back-end in /src-tauri/](https://github.com/kleineluka/modnamedhana/tree/main/src-tauri/src) and the [front-end in /src/](https://github.com/kleineluka/modnamedhana/tree/main/src)!

### Bugs, Grammar, and Feedback
- For now, please either [open an issue on Github](https://github.com/kleineluka/modnamedhana/issues) or reach out to me on Discord at `kleinezoey`!

# Credits & Licenses 🎉
- 🕹ī¸ **Mod Named Hana** is licensed under the [MIT License](https://github.com/kleineluka/modnamedhana/blob/main/LICENSE).
- 🕹ī¸ **[Repurpose Studios](https://residentrabbit.itch.io/repurpose)** for creating the game, the character Hana, and assets for the game (such as the emoji used here).
- 💾 **[KleineLuka (Zoey)](https://www.github.com/kleineluka)** for creating Mod Named Hana's patch/installer. You can find me on Discord as `kleinezoey`!
- ✏ī¸ Your name could go here for writing or art.. which I cant do well.. ~~or at all~~.
- 💾 **[Tauri](https://github.com/tauri-apps/tauri)**, the Rust-based front-end framework, is licensed under MIT/Apache.
- 💾 **[RenPy](https://www.renpy.org/)**, the game engine, is licensed under the MIT License.
- 💾 **Libraries used** include [Wow.JS](https://wowjs.uk) (MIT), [SweetAlert2](https://github.com/sweetalert2/sweetalert2) (MIT), [Hover.CSS](https://github.com/IanLunn/Hover) (MIT), and [Animate.CSS](https://github.com/animate-css/animate.css) (Hippocratic License 2.1).
- ✏ī¸ **NotoSans** is Mod Named Hana installer's font of choice, which is under the [Open Font License](https://fonts.google.com/noto/specimen/Noto+Sans/about).