Ghost in M'Sheet

An attempt at continuing Trykowka's "The Ghost Hunter".

Original Author

This fork is maintained independently and the original author, Trykowka, is not involved in these updates. If you'd like to support the original creator, you can find their Patreon here: https://www.patreon.com/Yaldabaoth

Quick Start

Prerequisites

• Tweego (Twee/Twine compiler)
  • Download from: https://github.com/tmedwards/tweego
  • Or use the automated setup script below
• Python 3 (for validation checks during build)
• Windows users: PowerShell 5+ (included with Windows 10/11)

Setup

Automated Setup (Recommended)

Run the setup script to automatically download and install Tweego and SugarCube:

Linux / macOS:

./scripts/setup.sh

Windows:

scripts\setup.bat

Manual Setup

If you prefer to set up Tweego manually:

1. Download Tweego from: https://github.com/tmedwards/tweego/releases
2. Extract the archive to the project root
3. Ensure the path in the build script matches your Tweego location:
   • Linux/macOS default: tweego-2.1.1-linux-x64/tweego
   • Windows default: tweego-2.1.1-windows-x64\tweego.exe
   • Or update the TWEEGO_PATH variable in scripts/build.sh / scripts/build.bat

Building the Project

Using VS Code (Recommended)

1. Open the project in VS Code
2. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
3. Type "Run Task" and select "Tasks: Run Task"
4. Choose "Build Story" to build the project
5. Choose "Open in Browser" to build the story and open it in your default browser

VS Code tasks automatically detect your OS and run the correct script.

Using Command Line

Linux / macOS:

# Build the story
./scripts/build.sh

# Build and open the story in your default browser
./scripts/start.sh

# Clean build artifacts
rm -f ghost-in-msheet.html

Windows:

:: Build the story
scripts\build.bat

:: Build and open the story in your default browser
scripts\start.bat

:: Clean build artifacts
del ghost-in-msheet.html

VS Code Integration

Keyboard Shortcuts

• Ctrl+Shift+B (or Cmd+Shift+B on Mac): Run Build Task
• Ctrl+Shift+P → "Run Task": Select from available tasks

Debugging

1. Build the story using the "Build Story" task (or run ./scripts/start.sh to build and open it)
2. Press F5 to launch the debugger
3. Choose your preferred browser (Chrome or Firefox)

Build Script Features

The scripts/build.sh script includes:

• Automatic error handling
• Verification of required files and dependencies
• Color-coded output for better visibility
• File size reporting
• Cleanup of existing output files
• Detailed error messages

Development Workflow

With File Watching

If you have inotify-tools installed:

npm run watch

This will automatically rebuild the story whenever source files change.

With npm (Cross-Platform)

npm scripts automatically detect your OS and run the correct build script:

# Install dependencies
npm install

# One-time setup (downloads Tweego & SugarCube)
npm run setup

# Build
npm run build

# Build and open in browser
npm start

# Watch for changes (Linux only, requires inotify-tools)
npm run watch

# Clean build artifacts
npm run clean

# Rebuild
npm run rebuild

Troubleshooting

Tweego not found

• Ensure Tweego is installed and in your PATH
• Or update the TWEEGO_PATH variable in scripts/build.sh

No .tw files found

• Verify that your story passages are in the passages/ directory
• Ensure files have the .tw extension

Build fails

• Check that all required files exist
• Verify file permissions (scripts/build.sh should be executable)
• Check the error output for specific issues

Output

The build process creates ghost-in-msheet.html, which can be:

• Opened directly in a web browser
• Served using a local development server
• Deployed to a web server

Customization

You can customize the build process by editing:

• scripts/build.sh / scripts/build.bat: Main build script (Linux+macOS / Windows)
• scripts/start.sh / scripts/start.bat: Build-and-open-in-browser script
• scripts/setup.sh / scripts/setup.bat: One-time setup script
• .vscode/tasks.json: VS Code task definitions (auto-detects OS)
• .vscode/launch.json: VS Code debug configurations

Documentation

• Setup Guide - Detailed setup instructions

License

GPLv3