Skip to content

Commit

Permalink
FINAL FINAL WIKI EDIT I SWEAR-
Browse files Browse the repository at this point in the history
  • Loading branch information
Reycko committed Mar 8, 2024
1 parent bd55afe commit 7514f18
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 8 deletions.
1 change: 0 additions & 1 deletion Console.resource_order
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
{"name":"GMLive_vm_init","order":7,"path":"scripts/GMLive_vm_init/GMLive_vm_init.yy",},
{"name":"GMLive_program","order":3,"path":"scripts/GMLive_program/GMLive_program.yy",},
{"name":"GMLiveAPI","order":3,"path":"scripts/GMLiveAPI/GMLiveAPI.yy",},
{"name":"obj_gmlive","order":4,"path":"objects/obj_gmlive/obj_gmlive.yy",},
{"name":"GMLive_token","order":7,"path":"scripts/GMLive_token/GMLive_token.yy",},
{"name":"fnt_console_small","order":1,"path":"fonts/fnt_console_small/fnt_console_small.yy",},
{"name":"GMLive_roomLoader","order":2,"path":"scripts/GMLive_roomLoader/GMLive_roomLoader.yy",},
Expand Down
2 changes: 0 additions & 2 deletions Console.yyp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions datafiles/wiki/Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ This will go over the basics of the console's features.
#### Table of contents:
- [The console](#the-console)
- [Interface](#interface)
- [Info bar](#interface-info-bar)
- [Output window](#interface-output-window)
- [Command bar](#interface-cmd-bar)
- [Info bar](#interface-info-bar)
- [Output window](#interface-output-window)
- [Command bar](#interface-cmd-bar)
- [Settings](#settings)

---
## <a name="the-console">The console</a>
Expand All @@ -22,7 +23,7 @@ GMConsole has a clear and colorful logs in a simple UI.
It has 3 parts: the info bar (top bar), the output window, and the command bar (cmd bar).
(This screenshot is from v0.3.00.00-dev, some text might have been changed.)
<!-- Fun fact: I had to redo this 3 times because I kept on changing strings for 0.3.00.00 (as it's the first public release) --->
![The 3 parts of GMConsole](./img/console-parts.png)
<img src="./img/console-parts.png" alt="The 3 parts of GMConsole" width=600px>

#### <a name="interface-info-bar">Info bar</a>
The info bar contains these fields:
Expand Down Expand Up @@ -51,3 +52,7 @@ This is where you input your commands. Here is an example of what happens in the
> Made with \<3 by Reycko
> You are on branch master (based on version name)
> Use command \`github\` to open the GitHub repo!
### <a name="settings">Settings</a>
To modify the settings as of 0.3.00.01, you need to go into the console's create object, scroll down to the "Settings" region inside of the "Console variables" region.
<img src="./img/console-settings.png" alt="Location of the settings struct">
9 changes: 8 additions & 1 deletion datafiles/wiki/Integrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,14 @@ con_log(obj_gmconsole.con.enum.logtype.debug, x);
// Or also like this, if you have set up the `gmc` macro (see gmconsole_init):
con_log(gmc.con.enum.logtype.debug, x);
```
Your object's X position now prints to the console every frame.
Your object's X position now prints to the console every frame.
The 4 log types in the enum are:
- `log`
- `warn`
- `error` or `err`
- `debug` (only prints if show_debug_logs is enabled)
<span style="color:yellow;"><img src="https://raw.github.com/Reycko/GMConsole/stable/datafiles/wiki/img/emoji/information.png" alt="[Information]" width=20px/> There is also the `none` log type, however, it is recommended not to use it as it's only supposed to be for multi-line strings in the output window.</span><br>
---
## <a name="adding-your-own-commands">Adding your own commands</a>
Expand Down
Binary file added datafiles/wiki/img/console-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7514f18

Please sign in to comment.