https://github.com/NiklasBorson/AdventureScript
Implements a scripting language for writing text adventure games.
https://github.com/NiklasBorson/AdventureScript
Last synced: about 2 months ago
JSON representation
Implements a scripting language for writing text adventure games.
- Host: GitHub
- URL: https://github.com/NiklasBorson/AdventureScript
- Owner: NiklasBorson
- License: mit
- Created: 2024-03-12T03:39:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-16T03:18:57.000Z (12 months ago)
- Last Synced: 2024-04-16T05:17:30.550Z (12 months ago)
- Language: C#
- Size: 4.87 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - NiklasBorson/AdventureScript - Implements a scripting language for writing text adventure games. (C# #)
README
# AdventureScript
AdventureScript is a scripting language and interpreter designed for implementing text
adventure games.
## Documentation
[AdventureScript Documentation](https://niklasborson.github.io/AdventureScript)
## Organization of this Project
This repo contains the following subdirectories:
- **AdventureScript** is a shared library that implements the interpreter and game
engine.
- **TextAdventure** is a terminal-based application implemented using the
AdventureScript library.
- **OxbowCastle** is a WinUI3 application implemented using the AdventureScript library.
- **Games** contains games implemented in AdventureScript. This includes a Demo game,
which is intended as a code sample for writing your own games.
- **AdventureTest** implements a set of tests for the game engine and for games.
- **AdventureDoc** implements a tool to generate HTML reference documentation from
AdvenureScript source code.
- **docs** contains the sources for the AdventureScript Documentation linked above.
## Contributions
Contributions are welcome. In particular, it is hoped that this project inspires people to
create their own games. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidance on how
to contribute to this project.
## Building the Project
You can build the project either from Visual Studio or from the command prompt.
To build from Visual Studio:
1. Open `AdventureScript.sln` in Visual Studio.
2. Chose "Build Solution" from the "Build" menu (or press CTRL+SHIFT+B).
To build from the command prompt, you do not need to have Visual Studio installed but
do need to have PowerShell and the .NET SDK installed. These are available for Linux
and Macintosh. The following instructions have been tested on Windows and Linux:
1. Start a PowerShell prompt and navigate to the repo root.
2. Type `Import-Module .\Adventure-Helpers.psm1`.
3. Type `build`
For more information about the Adventure-Helpers module, see [CONTRIBUTING.md](CONTRIBUTING.md).
Note: The Windows-specific OxbowCastle project is only built on Windows.
## Playing Games
You can play text adventure games in one of two ways:
- Using the **TextAdventure** console application from the terminal.
- Using the graphical **Oxbow Castle** application.
The graphical application has some additional capabilities, such as the ability to display
images.
### Running TextAdventure
The easiest way to run the TextAdventure game is using the Adventure-Helpers PowerShell
module:
1. Start a PowerShell prompt and navigate to the repo root.
2. Type `Import-Module .\Adventure-Helpers.psm1`.
3. Type `Get-Games` to see a list of available games.
4. Type `Invoke-Game ` to play a game.
5. Type `q` to quit.
For more information about the Adventure-Helpers module, see [CONTRIBUTING.md](CONTRIBUTING.md).
### Running the Oxbow Castle Application
**Oxbow Castle** is a graphical application built on the WinUI3 framework. It is named
after the flagship "Oxbow Castle" game but actually includes all the games in this project.
You can also browse to a directory containing your own game. Oxbow Castle provides a more
user-friendly experience than TextAdventure and also has additional capabilities such as
the ability to display images and save game progress.
You can run Oxbow Castle from Visual Studio as follows:
1. Open `AdventureScript.sln` in Visual Studio.
2. Build the solution if you haven't already.
3. Right-click the **OxbowCastle** project and choose "Set as Startup Project".
4. Click the "Start Without Debugging" button on the toolbar (or press CTRL+F5).
Alternatively, you can install the Oxbow Castle app from the Store app in Windows.