Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benpollarduk authored Jan 15, 2024
1 parent 7147d36 commit 9490b2b
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,14 @@ Maps display visited rooms, exits, player position, if an item is in a room, low
* Download free IDE Visual Studio 2022 Community ( >> https://visualstudio.microsoft.com/de/vs/community/ ), or use commercial Visual Studio 2022 Version.

## Getting Started
* Clone the repo.
* Build all projects.
* Run the BP.AdventureFramework.Examples project.

## Hello World
### Clone the repo
Clone the repo to the local machine.
```bash
git clone https://github.com/benpollarduk/adventure-framework.git
```

### Hello World
```csharp
// create the player. this is the character the user plays as
var player = new PlayableCharacter("Dave", "A young boy on a quest to find the meaning of life.");
Expand All @@ -130,5 +133,14 @@ var gameCreator = Game.Create("The Life Of Dave",
Game.Execute(gameCreator);
```

### Example game
The quickest way to start getting to grips with the structure of BP.AdventureFramework is by taking a look at the examples.
An example game is provided in the [BP.AdventureFramework.Examples](https://github.com/benpollarduk/adventure-framework/tree/main/BP.AdventureFramework.Examples) directory
and have been designed with the aim of showcasing the various features.

### Running the examples
The example applications can be used to execute the example BP.AdventureFramework game and demonstrate the core principals of the framework.
Set the **BP.AdventureFramweork.Examples** project as the start up project and build and run to start the application.

## For Open Questions
Visit https://github.com/benpollarduk/adventure-framework/issues

0 comments on commit 9490b2b

Please sign in to comment.