-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from Fuinny/new-file-structure
- Loading branch information
Showing
16 changed files
with
184 additions
and
144 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # :question: How to add your own company | ||
| 1. Open ```Companies.xml``` file. | ||
| 2. Find ```Company``` element. | ||
| 3. Copy the following template and paste it below last ```Company``` element: | ||
|
|
||
| ```xml | ||
| <Company id="COMPANY_ID"> | ||
| <Name>COMPANY_NAME</Name> | ||
| <Industry>COMPANY_INDUSTRY</Industry> | ||
| <SharePrice>COMPANY_SHARE_PRICE</SharePrice> | ||
| <Description>COMPANY_DESCRIPTION</Description> | ||
| </Company> | ||
| ``` | ||
|
|
||
| 5. Replace **COMPANY_ID**, **COMPANY_NAME**, **COMPANY_INDUSTRY**, **COMPANY_SHARE_PRICE**, and **COMPANY_DESCRIPTION** with the appropriate values for your new company. | ||
| 6. Save the changes to the ```Companies.xml``` file. | ||
|
|
||
| > **Please note:** | ||
| > | ||
| > **COMPANY_ID** - can be anything, make it so that it is easier for you to navigate in the ```.xml``` file, **but** you need to use underscore between words. Company name is used by default, but you can use something else. | ||
| > | ||
| > Example: ```ABC_Company_Id``` | ||
| > | ||
| > **COMPANY_NAME**, **COMPANY_INDUSTRY** and **COMPANY_DESCRIPTION** - can be anything, except null or whitespace. | ||
| > | ||
| > Example: ```ABC Company Name```, ```ABC Company Industry``` and ```ABC Company long-long-long description.``` | ||
| > | ||
| > **COMPANY_SHARE_PRICE** - can be any value greater than zero. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # :question: How to add your own event | ||
| 1. Open ```Events.xml``` file. | ||
| 2. Find ```Event``` element. | ||
| 3. Copy the following template and paste it below last ```Event``` element: | ||
|
|
||
| ```xml | ||
| <Event id="EVENT_ID"> | ||
| <Effect>EVENT_EFFECT</Effect> | ||
| <Target>EVENT_TARGET</Target> | ||
| <Title>EVENT_TITLE</Title> | ||
| <Content>EVENT_CONTENT</Content> | ||
| </Event> | ||
| ``` | ||
|
|
||
| 5. Replace **EVENT_ID**, **EVENT_EFFECT**, **EVENT_TARGET**, **EVENT_TITLE** and **EVENT_CONTENT** with the appropriate values for your new event. | ||
| 6. Save the changes to the ```Events.xml``` file. | ||
|
|
||
| > **Please note:** | ||
| > | ||
| > **EVENT_ID** - can be anything, make it so that it is easier for you to navigate in the xml file, **but** you need to use underscore between words. | ||
| > The default structure is: Company_Event, but you can use other structure. | ||
| > | ||
| > Example: ```ABC_Company_new_event``` | ||
| > | ||
| > **EVENT_EFFECT** - can be any integer except zero. | ||
| > | ||
| > **EVENT_TARGET** - **must** match the name of the company to which the effect is to be applied. Obviously cannot be null or whitespace. | ||
| > | ||
| > Example: ```ABC Company Name``` | ||
| > | ||
| > **EVENT_TITLE** and **EVENT_CONTENT** - can be anything, except null or whitespace. | ||
| > | ||
| > Example: ```ABC Company something happened``` and ```ABC Company long-long-long event content.``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # :question: How to add your own global event | ||
| 1. Open ```GlobalEvents.xml``` file. | ||
| 2. Find ```GlobalEvent``` element. | ||
| 3. Copy the following template and paste it below last ```GlobalEvent``` element: | ||
|
|
||
| ```xml | ||
| <GlobalEvent id="GLOBAL_EVENT_ID"> | ||
| <Effect>GLOBAL_EVENT_EFFECT</Effect> | ||
| <Title>GLOBAL_EVENT_TITLE</Title> | ||
| <Content>GLOBAL_EVENT_CONTENT</Content> | ||
| </GlobalEvent> | ||
| ``` | ||
|
|
||
| 5. Replace **GLOBAL_EVENT_ID**, **GLOBAL_EVENT_EFFECT**, **GLOBAL_EVENT_TITLE** and **GLOBAL_EVENT_CONTENT** with the appropriate values for your new event. | ||
| 6. Save the changes to the ```GlobalEvents.xml``` file. | ||
|
|
||
| > **Please note:** | ||
| > | ||
| > **GLOBAL_EVENT_ID*** - can be anything, make it so that it is easier for you to navigate in the xml file, **but** you need to use underscore between words. | ||
| > The default structure is: Company_Event, but you can use other structure. | ||
| > | ||
| > Example: ```ABC_Company_new_event``` | ||
| > | ||
| > **GLOBAL_EVENT_EFFECT** - can be any integer except zero. | ||
| > | ||
| > **GLOBAL_EVENT_TITLE** and **GLOBAL_EVENT_CONTENT** - can be anything, except null or whitespace. | ||
| > | ||
| > Example: ```ABC Company something happened``` and ```ABC Company long-long-long event content.``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <div> | ||
| <img align="left" src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/oligopoly-logo.svg" width="128" height="128"/> | ||
| <h1> | ||
| Oligopoly | ||
| <br> | ||
| Documentation Hub | ||
| </h1> | ||
| <p align="left"> | ||
| <a href="https://github.com/Fuinny/Oligopoly"><img src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/github-repo.svg" alt="GitHub Repository"></a> | ||
| <a href="https://github.com/dotnet/dotnet-console-games"><img src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/also-available.svg" alt="dotnet-console-games Repository"></a> | ||
| <a href="https://learn.microsoft.com/en-us/dotnet/csharp/"><img src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/c-sharp-language.svg" alt="C Sharp Language"></a> | ||
| <a href="https://dotnet.microsoft.com/en-us/download"><img src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/target-framework.svg" alt="Target Framework"></a> | ||
| <a href="https://github.com/Fuinny/Oligopoly/blob/main/LICENSE.md"><img src="https://github.com/Fuinny/Oligopoly/blob/main/.github/resources/license-MIT.svg" alt="Target Framework"></a> | ||
| </p> | ||
| </div> | ||
|
|
||
| # :open_book: Description | ||
| This documentation provides instructions on how to add your own content to the game like: companies, events, global events or edit existing content. | ||
| To make these changes, you will need to edit the appropriate ```.xml``` file in ```Data``` folder. It's not hard at all :D | ||
|
|
||
| Also, thank you for your interest in adding your own content to the game :P | ||
|
|
||
| # :globe_with_meridians: Links | ||
| All standard ```.xml``` files in the ```Data``` folder you can see [here](https://github.com/Fuinny/Oligopoly/tree/new-file-structure/Source/Oligopoly.Game/Data). | ||
|
|
||
| If you want to add your ```company``` to the game, you can find instructions [here](https://github.com/Fuinny/Oligopoly/blob/new-file-structure/Documentation/How-to-add-company.md). | ||
|
|
||
| If you want to add your ```events``` to the game, you can find instructions [here](https://github.com/Fuinny/Oligopoly/blob/new-file-structure/Documentation/How-to-add-event.md). | ||
|
|
||
| If you want to add your ```global events``` to the game, you can find instructions [here](https://github.com/Fuinny/Oligopoly/blob/new-file-structure/Documentation/How-to-add-global-event.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -110,4 +110,4 @@ public string Content | |
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -220,4 +220,4 @@ public static StringBuilder DrawCompaniesTable(List<Company> companies) | |
| return companiesTable; | ||
| } | ||
| } | ||
| } | ||
| } | ||
File renamed without changes.
Oops, something went wrong.