Skip to content

Commit a2a54d0

Browse files
authored
Finalize the README
1 parent b36b6a0 commit a2a54d0

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
1-
# UnityCtrlBackspace
2-
A BepInEx plugin that adds ctrl-backspace functionality to Unity input fields
1+
[![GitHub all releases](https://img.shields.io/github/downloads/RandomGuyJCI/UnityCtrlBackspace/total)](https://github.com/RandomGuyJCI/UnityCtrlBackspace/releases/latest)
2+
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/RandomGuyJCI/UnityCtrlBackspace/issues)
3+
4+
5+
<div align="center">
6+
<h1>UnityCtrlBackspace</h1>
7+
<i>A <a href="https://github.com/BepInEx/BepInEx">BepInEx</a> plugin that adds ctrl-backspace functionality to <a href="https://docs.unity3d.com/2018.4/Documentation/ScriptReference/UI.InputField.html">Unity Input Fields</a>.</i>
8+
</div>
9+
10+
---
11+
12+
<details><summary><h2>Demos</h2></summary>
13+
14+
https://user-images.githubusercontent.com/22722393/169652584-487c406e-a371-4c9f-9126-fc4635fded80.mp4
15+
<p align="center"><i>This plugin has full parity with ctrl-backspace functionality on most programs such as Notepad++.</i></p>
16+
17+
&emsp;
18+
19+
https://user-images.githubusercontent.com/22722393/169652585-344be85d-b7f4-4784-8707-548f32d84680.mp4
20+
<p align="center"><i>It also supports non-english text!</i></p>
21+
</details>
22+
23+
## Installation
24+
1. Install the latest build of [BepInEx 5](https://github.com/BepInEx/BepInEx/releases) for your Unity game. For more information, check out the [BepInEx installation guide](https://docs.bepinex.dev/articles/user_guide/installation/index.html).
25+
2. Download the latest version of the mod in the [releases](https://github.com/RandomGuyJCI/UnityCtrlBackspace/releases) page. It should be named `UnityCtrlBackspace_1.x.x.zip`.
26+
3. Extract the file into your main game folder. you should now have a file at `BepInEx/plugins/UnityCtrlBackspace/UnityCtrlBackspace.dll`.
27+
28+
## Development
29+
Although this plugin was originally built for Rhythm Doctor, it can also be installed/ported over to any Unity game that uses input fields for text input.
30+
31+
After cloning the repository, the Nuget.Config file should automatically install the BepInEx dependendies needed for development, although you still need to manually import a publicized version of the `UnityEngine.UI.dll` file. Instructions can be found over at the [NStrip](https://github.com/BepInEx/NStrip) GitHub page.

0 commit comments

Comments
 (0)