diff --git a/docs/docfx/docs/commands.md b/docs/docfx/docs/commands.md index 830c2f08..c93d5d96 100644 --- a/docs/docfx/docs/commands.md +++ b/docs/docfx/docs/commands.md @@ -60,13 +60,13 @@ take all ### Talk Talk allows the player to start a conversation with a NonPlayableCharacter. **L** can be used as a shortcut. -If only a single NonPlayableCharacter is in the current Room no argurment needs to be specified. +If only a single NonPlayableCharacter is in the current Room no argument needs to be specified. ``` talk ``` -However if the current Room contains two or more NonPlayableCharacters then **to** and the NonPlayableCharacters name must be specified. +However, if the current Room contains two or more NonPlayableCharacters then **to** and the NonPlayableCharacters name must be specified. ``` talk to dave @@ -111,7 +111,7 @@ end ## Global Commands ### About -Displays the a screen containing information about the game. +Displays a screen containing information about the game. ``` about @@ -172,4 +172,4 @@ new ``` ## Custom Commands -Custom commands can be added to many of the assets, including Room, PlayableCharacter, NonPlayableCharacter, Item and Exit. For more informations see their pages. +Custom commands can be added to many of the assets, including Room, PlayableCharacter, NonPlayableCharacter, Item and Exit. diff --git a/docs/docfx/docs/conditional-descriptions.md b/docs/docfx/docs/conditional-descriptions.md index ea6f95e6..5fa6c963 100644 --- a/docs/docfx/docs/conditional-descriptions.md +++ b/docs/docfx/docs/conditional-descriptions.md @@ -9,7 +9,7 @@ Descriptions are usually specified as a string. var item = new Item("The items name", "The items description."); ``` -They can also be specified as a **Desciption**. +They can also be specified as a **Description**. ```csharp var item = new Item(new Identifier("The items name"), new Description("The items description.")); diff --git a/docs/docfx/docs/exit.md b/docs/docfx/docs/exit.md index 67622fbd..fc80a0cc 100644 --- a/docs/docfx/docs/exit.md +++ b/docs/docfx/docs/exit.md @@ -2,7 +2,7 @@ ## Overview -An Exit is essentially a connector bewtween to adjoining rooms. +An Exit is essentially a connector between to adjoining rooms. ## Use diff --git a/docs/docfx/docs/frame-builders.md b/docs/docfx/docs/frame-builders.md index 3ca52e04..63a92a50 100644 --- a/docs/docfx/docs/frame-builders.md +++ b/docs/docfx/docs/frame-builders.md @@ -1,5 +1,5 @@ # Overview -In BP.AdventureFramework output is handled using the **FrameBuilders**. A FrameBuilder is essentially a class that builds a **Frame** that can render a specific state in the game. This **Frame** can the be rendered on a **TextWriter** by calling its **Render** method. Think of the **FrameBuilder** as the instructions that build the output display and the **Frame** as the output itself. +In BP.AdventureFramework output is handled using the **FrameBuilders**. A FrameBuilder is essentially a class that builds a **Frame** that can render a specific state in the game. This **Frame** can then be rendered on a **TextWriter** by calling its **Render** method. Think of the **FrameBuilder** as the instructions that build the output display and the **Frame** as the output itself. There are a few types of **FrameBuilder**, each responsible for rendering a specific game state. * **SceneFrameBuilder** is responsible for building frames that render the scenes in a game. diff --git a/docs/docfx/docs/getting-started.md b/docs/docfx/docs/getting-started.md index e594f2ef..57d07af4 100644 --- a/docs/docfx/docs/getting-started.md +++ b/docs/docfx/docs/getting-started.md @@ -1,6 +1,6 @@ # Getting Started -## Adding the NuGet pacakge to your project +## Adding the NuGet package to your project You need to pull BP.AdventureFramework into your project. The easiest way to do this is to add the NuGet package. The latest package and installation instructions are available [here](https://github.com/benpollarduk/BP.AdventureFramework/pkgs/nuget/BP.AdventureFramework). ## First Game @@ -35,7 +35,7 @@ private static PlayableCharacter CreatePlayer() In this example whenever **CreatePlayer** is called a new **PlayableCharacter** will be created. The character is called "Dave" and has a description that describes him as "A young boy on a quest to find the meaning of life.". ### Creating the game world -The game world consists of a heirachy of three tiers: **Overworld**, **Region** and **Room**. We will create a simple **Region** with two **Rooms**. We can do this directly in the **Main** function for simplicity. To start with lets make the **Rooms**: +The game world consists of a hierarchy of three tiers: **Overworld**, **Region** and **Room**. We will create a simple **Region** with two **Rooms**. We can do this directly in the **Main** function for simplicity. To start with lets make the **Rooms**: ```csharp private static void Main(string[] args) @@ -128,7 +128,7 @@ private static EndCheckResult IsGameOver(Game game) ``` ### Creating the game -The game now has all of the required assets and logic it just needs some boiler plate to tie everything together before it is ready to play. +The game now has all the required assets and logic it just needs some boilerplate to tie everything together before it is ready to play. A **GameCreationCallback** is required to instantiate an instance of a **Game**. This is so that new instances of the **Game** can be created as required. diff --git a/docs/docfx/docs/introduction.md b/docs/docfx/docs/introduction.md deleted file mode 100644 index 54f024ba..00000000 --- a/docs/docfx/docs/introduction.md +++ /dev/null @@ -1,2 +0,0 @@ -# Introduction -Work in progress, coming soon. diff --git a/docs/docfx/docs/items.md b/docs/docfx/docs/items.md index 81a78c3c..d9c62475 100644 --- a/docs/docfx/docs/items.md +++ b/docs/docfx/docs/items.md @@ -12,7 +12,7 @@ An Item can be simply instantiated with a name and description. var sword = new Item("Sword", "A heroes sword."); ``` -By default an Item is not takeable and is tied to a Room. If it is takeable this can be specified in the constructor. +By default, an Item is not takeable and is tied to a Room. If it is takeable this can be specified in the constructor. ```csharp var sword = new Item("Sword", "A heroes sword.", true); diff --git a/docs/docfx/docs/non-playable-character.md b/docs/docfx/docs/non-playable-character.md index 075c9b1e..c723751e 100644 --- a/docs/docfx/docs/non-playable-character.md +++ b/docs/docfx/docs/non-playable-character.md @@ -19,7 +19,7 @@ var daisy = new Item("Daisy", "A beautiful daisy that is sure to cheer up even t npc.Give(daisy, goblin); ``` -NonPlayableCharacters can contains custom commands that allow the user to directly interact with the character or other assets. +NonPlayableCharacters can contain custom commands that allow the user to directly interact with the character or other assets. ```csharp goblin.Commands = @@ -36,7 +36,7 @@ goblin.Commands = A NonPlayableCharacter can hold a conversation with the player. * A Conversation contains **Paragraphs**. * A Paragraph can contain one or more **Responses**. -* A **Response** can contain a delta to shift the conversation by, which will cause the conversation to jump parargraphs by the specified value. +* A **Response** can contain a delta to shift the conversation by, which will cause the conversation to jump paragraphs by the specified value. * A **Response** can also contain a callback to perform some action when the player selects that option. ```csharp diff --git a/docs/docfx/docs/playable-character.md b/docs/docfx/docs/playable-character.md index fa379e85..21ade596 100644 --- a/docs/docfx/docs/playable-character.md +++ b/docs/docfx/docs/playable-character.md @@ -28,7 +28,7 @@ A PlayableCharacter can be given items with the **AcquireItem** method. player.AcquireItem(new Item("Mallet", "A large mallet.")); ``` -A PlayableCharactr can loose an item with the **DequireItem** method. +A PlayableCharacter can lose an item with the **DequireItem** method. ```chsarp player.DequireItem(mallet); @@ -50,7 +50,7 @@ var daisy = new Item("Daisy", "A beautiful daisy that is sure to cheer up even t player.Give(daisy, goblin); ``` -PlayableCharacters can contains custom commands that allow the user to directly interact with the character or other assets. +PlayableCharacters can contain custom commands that allow the user to directly interact with the character or other assets. ```csharp player.Commands = diff --git a/docs/docfx/docs/room.md b/docs/docfx/docs/room.md index 46dfb386..3802a278 100644 --- a/docs/docfx/docs/room.md +++ b/docs/docfx/docs/room.md @@ -61,7 +61,7 @@ Characters can be removed from a Room with the **RemoveCharacter** method. region.RemoveCharacter(character); ``` -Rooms can contains custom commands that allow the user to directly interact with the Room. +Rooms can contain custom commands that allow the user to directly interact with the Room. ```csharp room.Commands =