Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Crossedfall authored Oct 17, 2023
1 parent 13ca157 commit 684da0a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A collection of RedBot cogs for the OpenDream project

| Cog | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OD Compile | **Compiles and runs DM code using OpenDream**.<br><br>`odcompileset` - OD Compiler Settings<br>`odcompile` - Sends code to a compilation environment and returns the results*<br><br>Requires: httpx<br><br>* Requires additional setup, check below for more information |
| OD Compile | **Compiles and runs DM code using OpenDream**.<br><br>`odcompileset` - OD Compiler Settings<br>`odcompile` - Sends code to a compilation environment and returns the results*<br>`odcompiledebug` - Sends code to be compiled using a debug build of OpenDream*<br><br>Requires: httpx<br><br>* Requires additional setup, check below for more information |

## Setup

Expand All @@ -17,6 +17,11 @@ Setup for your RedBot V3 instance is a straightforward process. Ensure that your
2. Install the cog(s) you want to use, `[p]cog install od-cogs odcompile`
3. Load the newly installed cog(s) with `[p]load odcompile`

To use odcompile's context commands, you'll also need to register the interactions with discord. To do so,

1. Enable the commands with `[p]slash enablecog odcompile`
2. Sync the interactions with `[p]slash sync` (Note: This can take up to 1-hour for Discord to fully sync the commands)

_Replace [p] with your bot's prefix_

---
Expand All @@ -28,7 +33,7 @@ The ODCompile cog parses provided DM code and sends it to an external environmen
In order to use this cog, you will need to either use a preestablished environment or host your own using this listener: https://github.com/OpenDreamProject/od-compiler-bot

Short one-liners can be provided in basic code-markdown, for example:
`world.log < "Hello, World!"`
`world.log << "Hello, World!"`

Multi-line or explicit code must be contained within a codeblock, for example:
```dm
Expand Down Expand Up @@ -66,6 +71,9 @@ _Code will always be compiled with the latest version of OpenDream_
- ![image](https://github.com/OpenDreamProject/od-cogs/assets/26130695/378dd849-afa7-4024-8983-b9f44e8c6881)
- **Passing multiple arguments at once and disabling the parsed output**
- ![image](https://github.com/OpenDreamProject/od-cogs/assets/26130695/d13c003c-86e6-4bac-951d-00d42a4ac746)
- **Using the context menu to compile**
- ![context_compile](https://github.com/OpenDreamProject/od-cogs/assets/26130695/f33fbabb-cec6-4c8b-9e24-8ff71b2553bd)

</details>

### Contact:
Expand Down

0 comments on commit 684da0a

Please sign in to comment.