TibixDev/renquill

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Live Website
   • Build Instructions
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Renquill is an app that helps you translate your RenPy visual novels. We provide a nice interface for all your translation projects, where you can easily save, export, and track your progress. Renquill supports all visual novels that were made in Ren'Py. It runs on the web so once you have your project imported or a project file, you don't need anything other than a web browser to work on your translations.

(back to top)

Built With

• 

(back to top)

Getting Started

Renquill is a simple webapp that can be hosted anywhere, we have a Vercel instance down below, or you can tweak and build the project yourself.

Live Website

We have Renquill hosted on Vercel here for your convinience.

Building

1. Clone the repo

   git clone https://github.com/TibixDev/Renquill.git
   

2. Install NPM packages

   npm install
   

3. Build the project

   npm run build
   

4. Preview or host the build

   npm run preview
   

(back to top)

Roadmap

• Textareas should extend to at least the to-be-translated text height
• The ability to merge different project files (RenPy already does this)
• The ability to update an existing project if the VN receives new strings (RenPy already does this)
• You tell me

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Tibix - @TeaboxDev - [email protected]

Project Link: https://github.com/TibixDev/Renquill

(back to top)