Skip to content

A RuneApps app for transcribing RuneScape dialogue in the format used by the RuneScape Wiki

License

Notifications You must be signed in to change notification settings

cache117/RSWikiTranscriber

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a WIP Alt1 app for transcribing RuneScape dialogue in the format used by the RuneScape Wiki.

Installing

This app must be run through Alt1. It will refuse to work if it isn't. Alt1 can be downloaded here.

Once you have installed Alt1, follow these steps to add this app to it:

To use the Wiki's hosted version:

  1. Open this link
  2. Click the link to open the app in Alt1
  3. Alternatively, copy https://chisel.weirdgloop.org/gazproj/alt1/transcribe/index.html and paste it into the Alt1 browser (by opening the Alt1 Toolkit menu, then clicking Browser)
  4. Click the Add App button in the upper-right corner

If you wish to host the app locally yourself:

  1. Ensure you have npm installed, as the code now uses npm, typescript, and webpack to run.
  2. Clone or download this repository.
  3. If you downloaded it as a zip file, extract the files somewhere you'll remember.
  4. Run npm i followed by npm run build to webpack all of the files into the right location.
  5. Open Alt1, and open the Alt1 browser (by opening the Alt1 Toolkit menu, then clicking Browser).
  6. Paste the local file path to the dist/index.html file into the browser's address bar.
  7. Alternatively, navigate to the newly created dist folder and launch the index.html file in your browser.
  8. Click the Add App button in the upper right corner.

Using RSWikiTranscriber

  1. Launch RSWikiTranscriber from Alt1.
  2. Enter your name in the text area that says Player Name, if you want your name to be automatically replaced with the word Player. This will be saved in local storage across usages of this app.
  3. Press Start
  4. Talk to an NPC
  5. When you're given dialogue options, make sure you click the corresponding button on the RSWikiTranscriber window. You can do this before or after clicking the option.
    • Alternatively, you can hover your mouse over a dialogue option and press Alt+1. You'll have to do this before clicking the option.
  6. At any time, press Export to print the current state of the dialogue tree.
    • This will happen automatically if the Auto-export dialogue checkbox is checked.
  7. If you need to go through a dialogue multiple times, pressing Stop then Start again will allow you to try to combine several paths through a conversation into a single tree.
    • The app will attempt to do this automatically, but if very similar dialogue (that is not actually a repeat) is encountered, it may overwrite parts of the dialogue tree.
  8. Press Clear to completely clear the dialogue tree and start over.

The app only requires the "View screen" permission to function, but enabling the "Show overlay" permission lets the app show an overlay to which keeps track of which dialogue options you have selected in the past. Currently, this overlay only lasts for up to about 20 seconds, due to limitations of the Alt1 overlay API.

About

A RuneApps app for transcribing RuneScape dialogue in the format used by the RuneScape Wiki

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 80.1%
  • JavaScript 10.3%
  • HTML 9.6%