Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkKronicle committed Apr 11, 2022
2 parents cb30f99 + fac9c03 commit 20849e8
Show file tree
Hide file tree
Showing 16 changed files with 143 additions and 176 deletions.
Binary file removed docs/chatBox/assets/images/ACC_Page.PNG
Binary file not shown.
9 changes: 3 additions & 6 deletions docs/chatBox/chatBox.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ has_children: false

---
### AdvancedChatBox
- Complex writing of messages and formatting in the text box.</b>
- Complex writing of messages and formatting in the text box.

The information on this page is for the features of the ChatBox module of AdvancedChat. You can see the available sections in the Table of Contents, listed above.

Expand All @@ -28,9 +28,6 @@ The information on this page is for the features of the ChatBox module of Advanc
The following section will go over all the available tabs and settings in each tab that you can modify. This information can also be found [here](https://darkkronicle.github.io/AdvancedChatCore/modules/modulesOverview.html),
in the AdvancedChat-Modules Overview section. As well as overviews for all other modules available as of January 31st 2022.

<u>ACC Page Guide</u>
![ACC Page Help Map](./assets/images/ACC_Page.PNG)

Once the mod is installed a **<u>Box</u>** tab will be added to the AdvancedChat Config Menu. As well as a cog button in the lower right of the screen when chat is opened that comes by default in the AdvancedChat Core. Located in that tab are the following;

***General Tab***
Expand Down Expand Up @@ -81,7 +78,7 @@ In this tab you will also find two buttons on the upper right side above the fir

**Configure Suggestors Button**
- Suggest Players - If you want player names to be suggested or not.
- In-Chat Calculator - Whether or not you want an in chat calculator active or not. It can be used by simply putting a math expression in brackets and pressing TAB which will give your answer as a suggestion. It should be noted that the In-chat calculator uses [mXparser](https://darkkronicle.github.io/AdvancedChatCore/). <!--This link will eventually point to the Common Knowledge page on the Wiki -->
- In-Chat Calculator - Whether or not you want an in chat calculator active or not. It can be used by simply putting a math expression in brackets and pressing TAB which will give your answer as a suggestion. It should be noted that the In-chat calculator uses mXparser. (*Please [see](https://darkkronicle.github.io/AdvancedChatCore/commonKnowledge/commonKnowledgeMATH.html) page of the wiki for all information on the Maths format used in this mod.*)
- Suggest Shortcuts - When typing in chat you can have the option that when you type a certain string you can get a corresponding shortcut. So typing :happy then double tapping TAB will produce `o((*^▽^*))o`
-When selecting the Configure option here you are taken to a page where you can see a full list of pre-added shortcuts which you can modify or remove. As well as the option to 'Add Shortcut' to modify.
-To modify a shortcut simply click the corresponding text box and change the character as you please.
Expand All @@ -92,7 +89,7 @@ In this tab you will also find two buttons on the upper right side above the fir
- Command Color - What color a command is by default.
- Error Color - The color that highlights an incorrect command.
-Default Palette - The palette used by the above Command Color option for parts of commands. Custom ones can be added at ~/minecraft/config/advancedchat/colors.toml
- Highlight JSON in Commands - Whether or not you want your JSON parsed and highlighted in the [ChatHUD Module](https://darkkronicle.github.io/AdvancedChatCore/chatHUD/ChatHUD.html)
- Highlight JSON in Commands - Whether or not you want your JSON parsed and highlighted in the [ChatHUD Module](https://darkkronicle.github.io/AdvancedChatCore/chatHUD/ChatHUD.html).
- Color Code Formatting - Decides if the color codes with & are parsed and highlighted in the correct color.

**Spell Checker Tab**
Expand Down
85 changes: 41 additions & 44 deletions docs/chatHUD/ChatHUD.md

Large diffs are not rendered by default.

Binary file removed docs/chatHUD/assets/images/ACC_Page.PNG
Binary file not shown.
Binary file added docs/chatHUD/assets/images/ChatHUDTab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatHUD/assets/images/ChatHxW.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatHUD/assets/images/ChatLineStyle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatHUD/assets/images/ChatPaddingUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatHUD/assets/images/ChatTabsTab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatLog/assets/images/ACC-ChatLog_Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatLog/assets/images/LogTAB.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatLog/assets/images/logGUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/chatLog/assets/images/logView.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/chatLog/chatLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: default
title: Log
nav_order: 5
has_children: false
---

# AdvancedChat ChatLog Overview
<details open markdown="block">
<summary>
Table of contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>

---
![ACC-ChatLogIcon](./assets/images/ACC-ChatLog_Icon.png)
### AdvancedChatLog
- View, store and sort through mass amounts of previous messages.

---
### Overview
{:toc}
The information on this page is for the features of the **<u>ChatLog</u>** module of AdvancedChat.
Once the mod is installed a **<u>Chat Log</u>** tab will be added to the AdvancedChat Config Menu, as well as a button in the chat GUI that looks like 3 stacked bars.

**A bit of information**
This mod allows you to not only store messages typed in game to a local file, but also allows the ability to leave the game either to the menu or to the desktop, and come back to your world with your previously sent messages.
You can configure how many lines of chat are stored, as well as how many of those stored lines will be saved in order to be loaded the next time you play. Plus you can also search those saved lines in game via a chat GUI button.

---
### Available Tabs and Settings
{:toc}
The following section will go over all the available tabs and settings in each tab that you can modify. This information can also be found [here](https://darkkronicle.github.io/AdvancedChatCore/modules/modulesOverview.html), in the Modules Overview section. As well as overviews for all other modules available as of January 31st 2022.

**In Game Buttons**
- The Chatlog module adds an additional button to the right of the UI that looks like 3 stacked bars once the chat is opened. That is used to view and search chat. The search options use the **Filter Type** button that cycles the options;
- **Literal**, exact match.
- **Upper-Lower**, literal but not case-sensitive.
- **RegEx**, Parses the strings as Regular Expression.
- **Custom**, Allows for custom search parameters.

![Log GUI](./assets/images/logGUI.png)

***Chat Log Tab***
- Stored Lines - This value dictates how many lines of information are saved to the log file. Fair warning, large numbers may result in out of memory errors.
- Saved - Lines - The amount of stored lines that are loaded when the game starts.
- Clean Saved Lines - When true this will make it so that the log doesn't save things like mouse clicks and movements to help reduce the logs file size.

![Log Tab](./assets/images/LogTAB.png)

**Output File**
- It should be noted that the location of the log output file is in your .minecraft folder, either in the directory in the 'chatlogs' folder or in your profiles 'chatlogs' folder. (*~/.minecraft/chatlogs/ -OR- ~/.minecraft/MC_Profile_Name/chatlogs/*)

![Log Output View](./assets/images/logView.png)

<!--This documentation was written by Nomad on February 14th 2022 Happy Valentines Day <3 -->
115 changes: 10 additions & 105 deletions docs/commonKnowledge/commonKnowledgeCOLOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,111 +44,16 @@ It also has some information on things like color theory and shading. Pick your
---
## HEX Opacity Table
{:toc}
Here is a complete table from 0% opacity all the way up to 100% opacity at single percent increments...It should be noted that you wont see much of a difference from say 1% to 3% and there is really no need to do 0-100, probably could've gotten away with 5% increments. But what can I say? I like ya, you got moxxy kid.
**Remember**, the closer to 100% the value is the less transparent it is.
Here is a complete table from 0% opacity all the way up to 100% opacity at single percent increments...It should be noted that you wont see much of a difference from say 1% to 3%. You more than likely will see the best result when working at 5% increments. I included 1% increments incase you want to dial it in after getting in the ball park of where youd like it. <u>Remember</u>! The **closer** to 100% the value is the **less** transparent it is.

|Transparency % | HEX Value|
| :---: | :---: |
|0%|00|
|1%|02|
|2%|05|
|3%|07|
|4%|0A|
|5%|0C|
|6%|0F|
|7%|11|
|8%|14|
|9%|16|
|10%|19|
|11%|1C|
|12%|1E|
|13%|21|
|14%|23|
|15%|26|
|16%|28|
|17%|2B|
|18%|2D|
|19%|30|
|20%|33|
|21%|35|
|22%|38|
|23%|3A|
|24%|3D|
|25%|3F|
|26%|42|
|27%|44|
|28%|47|
|29%|49|
|30%|4C|
|31%|4F|
|32%|51|
|33%|54|
|34%|56|
|35%|59|
|36%|5B|
|37%|5E|
|38%|60|
|39%|63|
|40%|66|
|41%|68|
|42%|6B|
|43%|6D|
|44%|70|
|45%|72|
|46%|75|
|47%|77|
|48%|7A|
|49%|7C|
|50%|7F|
|51%|82|
|52%|84|
|53%|87|
|54%|89|
|55%|8C|
|56%|8E|
|57%|91|
|58%|93|
|59%|96|
|60%|99|
|61%|9B|
|62%|9E|
|63%|A0|
|64%|A3|
|65%|A5|
|66%|A8|
|67%|AA|
|68%|AD|
|69%|AF|
|70%|B2|
|71%|B5|
|72%|B7|
|73%|BA|
|74%|BC|
|75%|BF|
|76%|C1|
|77%|C4|
|78%|C6|
|79%|C9|
|80%|CC|
|81%|CE|
|82%|D1|
|83%|D3|
|84%|D6|
|85%|D8|
|86%|DB|
|87%|DD|
|88%|E0|
|89%|E2|
|90%|E5|
|91%|E8|
|92%|EA|
|93%|ED|
|94%|EF|
|95%|F2|
|96%|F4|
|97%|F7|
|98%|F9|
|99%|FC|
|100%|FF|
<details>
<summary> Click here to show the Opacity Table </summary>

| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|Opacity% | 0% | 1% | 2% | 3% | 4% | 5% | 6% | 7% | 8% | 9% | 10% | 11% | 12% | 13% | 14% | 15% | 16% | 17% | 18% | 19% | 20% | 21% | 22% | 23% | 24% | 25% | 26% | 27% | 28% | 29% | 30% | 31% | 32% | 33% | 34% | 35% | 36% | 37% | 38% | 39% | 40% | 41% | 42% | 43% | 44% | 45% | 46% | 47% | 48% | 49% | 50% | 51% | 52% | 53% | 54% | 55% | 56% | 57% | 58% | 59% | 60% | 61% | 62% | 63% | 64% | 65% | 66% | 67% | 68% | 69% | 70% | 71% | 72% | 73% | 74% | 75% | 76% | 77% | 78% | 79% | 80% | 81% | 82% | 83% | 84% | 85% | 86% | 87% | 88% | 89% | 90% | 91% | 92% | 93% | 94% | 95% | 96% | 97% | 98% | 99% | 100% |
|Hex# | 00 | 02 | 05 | 07 | 0C | 0C | 0F | 11 | 14 | 16 | 19 | 1C | 1E | 21 | 23 | 26 | 28 | 2B | 2D | 30 | 33 | 35 | 38 | 3A | 3D | 3F | 42 | 44 | 47 | 49 | 4C | 4F | 51 | 54 | 56 | 59 | 5B | 5E | 60 | 63 | 66 | 68 | 6B | 6D | 70 | 72 | 75 | 77 | 7A | 7C | 7F | 82 | 84 | 87 | 89 | 8C | 8E | 91 | 93 | 96 | 99 | 9B | 9E | A0 | A3 | A5 | A8 | AA | AD | AF | B2 | B5 | B7 | BA | BC | 8F | C1 | C4 | C6 | C9 | CC | CE | D1 | D3 | D6 | D8 | DB | DD | E0 | E2 | E5 | E8 | EA | ED | EF | F2 | F4 | F7 | F9 | FC | FF |

</details>

<!--This documentation was written by Nomad on February 8th 2022-->
Loading

0 comments on commit 20849e8

Please sign in to comment.