Documentation

FAQs

Installing and updating the app, themes, and addons

How do I install the app?

The best and easiest way:

StimuWrite 2 is compatible with the itchio app, so you can use it to download the app and automatically keep it up to date. This is the easiest way to make sure it runs and says up to date on your computer. Download the itchio app here

Install manually:

Download StimuWrite from itchio and place it in your applications folder. StimuWrite is an unsigned app, which means on macos you will have to follow the below steps. Using the itchio app avoids this issue.

Double click to open the zip and then drag the app icon into your Applications folder in Finder.
Control click or right click on the Application icon in the Finder and select "Open" and confirm you want to open an unidentified app. You may have to do this step twice to get the "Open" option

How do I update StimuWrite?

If you installed it with the itchio app, StimuWrite will update automatically. To update it manually, simply delete your old copy of StimuWrite and replace it with the new one. If you're using Windows, make sure the PCK file is in the same folder as the exe file.

How do I install themes and addons?

Download the theme/theme pack/addon to your computer. Do this from the website, do not use the itchio app.
In StimuWrite version 2 and above, click the "Options" link button at the bottom of the writing panel, next to "About"
Select "Install Themes & Add-ons"
Click "Install Theme or Add-on" button and select the theme file in your file folder
That's it! Your new themes will appear in the Theme dropdown

To delete the theme pack after installation: To delete an individual themes or theme packs, go to Options > Manage Themes & Addons. If you are uninstalling StimuWrite and want to make sure the themes and addons are removed from your computer, make sure to go to Options > Advanced Settings > Delete All. This will delete all StimuWrite content from your hard drive.

How do I update a theme or addon?

You must delete it in Options > Manage Themes & Addons and the reinstall it. Your data will not be lost.

I installed an addon. How do I use it?

After you successfully install your first addon, a menu semi-transparent button to open the addon bar will appear in the bottom left corner of the screen. Click that to access your addon. Some addons add features automatically and will not show in the bar. If you moved your emoji to the left side, the addon menu button will be on the lower right hand corner instead. See individual addon pages for specific instructions.

Writing and formatting

How do I do bold and italics

While you cannot make words bold or italicized inside StimuWrite, you can use markdown to export your work with these formatting features. If you go into Options > Advanced Settings there is an option to turn on "Export as html using markdown syntax" which gives you the ability to include bold, italics, underline, and strike through in your exported file when using markdown syntax.

When this setting is on, StimuWrite will export your work as an HTML file. You can then open the file in your browser and copy and paste your formatting from the exported document.

Supported syntax:

Bold: Surround your text to be bold with two asterixes **like this**
Italics: Surround with one asterix *like this*
Underline: Surround the text with two underscores __like this__
Strikethrough: Surround the text with two tilde ~~like this~~

To create a markdown file, turn this off to export as txt and then rename the file extension to .md or .markdown

Note: Using the copy button will not output rich text, you must export it.

Is there a spelling and grammar checker?

Currently there is not, as the emphasis is on drafting and not editing, but this feature is being considered.

Customizing the interface

How do I hide the sidebar and/or enter compact mode?

Next to the Word Count Goal, in the top right, there is a handle button that looks like this: ||. Click or drag it to close the sidebar. Once the sidebar is hidden, a collapse button, that looks like this <, will appear. Press that to enter compact mode. You can export your work while the sidebar is hidden by pressing the export button below it, or using the keyboard shortcut Ctrl + S.

Can I hide the progress bar?

Yes, you can do this in the Display Customizations panel. Click Options > Display Customizations

Can I customize what the emoji look like, how they appear, or turn them off?

Yes. Go to Options > Emoji Options to customize the emoji, what side they appear on, and how often they show.

Can I import my own emoji and backgrounds?

Yes, you can do this in the Display Customizations panel. Click Options > Display Customizations

Can I import my own sounds and fonts?

No, unfortunately that is not supported at this time.

Can I make my own theme?

Absolutely! There is a theme template on github, and a tutorial on youtube to help you. Feel free to email me if you have any questions.

Other platforms and features

Can I request a feature, theme, or addon?

Yes, email me with your idea. However, I can't make any promises that I can fulfill your request.

Are there plans for an android/iOS/web version?

Unfortunately, development for these versions has been stalled indefinitely due to technical limitations. Please follow StimuWrite on social media for updates on this.

Troubleshooting

You lost your words due to a crash or accidental close

Fear not! Your words are (hopefully) saved in the recovery file. Go to Options > Recover Session.

In the future, you may also want to export your work frequently in the background by using the keyboard shortcut Ctrl + S/Cmd + S

StimuWrite is crashing during use

If you are experiencing frequent crashing please try the following actions:

Make sure you are using the latest version of StimuWrite. Downloading it through the itchio app will keep it up to date.
Close other programs while using StimuWrite if possible. Do not leave StimuWrite open if you aren't using it.
Make sure your graphics card driver is up to date. StimuWrite is built on a game engine, and sometimes bugs in drivers will affect stability.
Turn off custom emojis and backgrounds in Options > Display Customizations. Malformed or outside image files may cause crashing in certain machines.
Increase the frequency of recovery file saving in Options > Advanced Settings. This will not improve stability, but will save your words more often. However, writing to the recovery file frequently may slow down StimuWrite.
Export your work frequently in the background by using the keyboard shortcut Ctrl + S/Cmd + S
Make sure you have the latest version of your OS, particularly on Windows.

StimuWrite crashes on open

If StimuWrite crashes on open, there is likely a corrupt theme or config file. Perform the following steps:

Navigate to the StimuWrite user data folder in your computer ( you may have to unhide hidden files and folders)
Windows: %APPDATA%\Godot\app_userdata\StimuWrite\ macOS: ~/Library/Application Support/Godot/app_userdata/StimuWrite/ Linux: ~/.local/share/godot/app_userdata/StimuWrite/
Delete the addons folder
Delete stimuwrite.cfg
Restart the program

Visual glitches

Make sure your graphics driver is up to date and that you have the latest version of StimuWrite.
Try fullscreen mode.

StimuWrite is too slow

Turn off "Typing sounds overlap"
Make sure you are using the latest version of StimuWrite. Downloading it through the itchio app will keep it up to date.
Close other programs while using StimuWrite if possible.
Make sure your graphics card driver is up to date. StimuWrite is built on a game engine, and sometimes bugs in drivers will affect performance.
Turn off custom emojis and backgrounds in Options > Display Customizations
Decrease the frequency of recovery file saving in Options > Advanced Settings. This will save your recovery file less often, but should improve performance.

You got an error message within the app

"Error 342: The theme or addon already exists," but when you go to Manage Themes & Addons there's nothing there

Something went wrong when installing a theme or addon. Go to Options > Advanced Settings > Delete All. Unfortunately, you will have to reinstall all of your themes and addons. If this does work, follow the steps for "StimuWrite crashes on open"

If you are having other issues, or need more help with one of these issues, please go to Report Issue and contact me.