Skip to content

Commit

Permalink
Merge pull request #47 from CWolfs/develop
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
CWolfs authored Dec 2, 2022
2 parents d927ab1 + 4bada35 commit f892afb
Showing 1 changed file with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,46 @@ Use [ConverseTek - Sim Conversation Editor](https://github.com/CWolfs/ConverseTe

## Installation Instructions

* Move into your ModTek `Mods` folder
* Move the `operations` folder into your `ConverseTek/defs` folder. This will enable all the conditions, actions and value getters from Extended Conversations in ConverseTek.
- Move into your ModTek `Mods` folder
- Move the `operations` folder into your `ConverseTek/defs` folder. This will enable all the conditions, actions and value getters from Extended Conversations in ConverseTek.

## Features

### Dialog Tags

Dialog tags allow you to inject data into your dialog text.
Dialog tags allow you to inject data into your dialog text.

* `<Stats.Company.[StatName]>` - This allows you to inject any company stat (e.g. `<Stats.Company.MyStatName>`)
* `<Stats.Commander.[StatName]`> - This allows you to inject any commander stat
* `<Stats.CurrentSystem.[StatName]`> - This allows you to inject any current system stat
- `<Stats.Company.[StatName]>` - This allows you to inject any company stat (e.g. `<Stats.Company.MyStatName>`)
- `<Stats.Commander.[StatName]`> - This allows you to inject any commander stat
- `<Stats.CurrentSystem.[StatName]`> - This allows you to inject any current system stat

### Conditions

* `Evaluate Tag for Current System` - This allows you to check if the current star system has the tag specified.
* `Evaluate BattleTech String` - This allows you to check against a commander, company or current system string statistic.
* `Evaluate BattleTech Int` - This allows you to check against a commander, company or current system integer statistic.
* `Evaluate BattleTech Float` - This allows you to check against a commander, company or current system float statistic.
* `Evaluate Funds` - This allows you to check a fund amount against the company funds.
- `Evaluate Tag for Current System` - This allows you to check if the current star system has the tag specified.
- `Evaluate BattleTech String` - This allows you to check against a commander, company or current system string statistic.
- `Evaluate BattleTech Int` - This allows you to check against a commander, company or current system integer statistic.
- `Evaluate BattleTech Float` - This allows you to check against a commander, company or current system float statistic.
- `Evaluate Funds` - This allows you to check a fund amount against the company funds.

### Actions

* `Time Skip` - This allows you to jump forward in time by the set amount. This processes the usual mechanics like healing, repairs and monthly fees.
* `Set Current System` - This allows you to set the current star system by star system id (e.g. starsystemdef_Smithon), with the option of using the calculated travel time or not.
* `Modify Funds` - This allows you to add, or remove, X amount of cbills from the company funds.
* `Start Conversation Custom` - This starts a group conversation for you. You specify the conversation id, header and subheader.
* `Set Characters Visible` - This allows you to show and hide characters in the dropship. You specify the characters in a comma separated list.
* `Add Contract` - This allows you to add a contract to the contracts list in the XOs room.
- `Time Skip` - This allows you to jump forward in time by the set amount. This processes the usual mechanics like healing, repairs and monthly fees.
- `Set Current System` - This allows you to set the current star system by star system id (e.g. starsystemdef_Smithon), with the option of using the calculated travel time or not.
- `Modify Funds` - This allows you to add, or remove, X amount of cbills from the company funds.
- `Start Conversation Custom` - This starts a group conversation for you. You specify the conversation id, header and subheader.
- `Set Characters Visible` - This allows you to show and hide characters in the dropship. You specify the characters in a comma separated list.
- `Add Contract` - This allows you to add a contract to the contracts list in the XOs room.
- `Add Flashpoint` - This allows you to add a flashpoint to the starmap. See [usage instructions](https://github.com/CWolfs/ExtendedConversations/issues/44#issuecomment-1335134292).

### Value Getters

* `Get BattleTech String` - This can be used in the above conditions and actions. It allows you to grab a commander, company or current system string statistic for use in the other operations. An example would be storing a system id in a company stat, then using this to pull out the system id in the `Set Current System` action.
* `Get BattleTech Int` - Same as above but for the return type of 'int'
* `Get BattleTech Float` - Same as above but for the return type of 'float'
- `Get BattleTech String` - This can be used in the above conditions and actions. It allows you to grab a commander, company or current system string statistic for use in the other operations. An example would be storing a system id in a company stat, then using this to pull out the system id in the `Set Current System` action.
- `Get BattleTech Int` - Same as above but for the return type of 'int'
- `Get BattleTech Float` - Same as above but for the return type of 'float'

## Author

Richard Griffiths (CWolf)
* [Twitter](https://twitter.com/CWolf)
* [LinkedIn](https://www.linkedin.com/in/richard-griffiths-436b7a19/)

- [Twitter](https://twitter.com/CWolf)
- [LinkedIn](https://www.linkedin.com/in/richard-griffiths-436b7a19/)

0 comments on commit f892afb

Please sign in to comment.