Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organized things and added README.md/Added emoji spec #1

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

GL513
Copy link

@GL513 GL513 commented Feb 2, 2023

I dunno maybe the last part in the readme is too much?

@GL513 GL513 changed the title Organized things and added README.md Organized things and added README.md/Added emoji spec Feb 2, 2023
protocol.md Outdated
Comment on lines 404 to 406
![ Status | Method | Domain | File | Initiator | Type | Transfered
GET | (lock icon) stream.mattkc.com | emotes | jquery-3.6.1.min.js | html | 1.68 kB (raced)
GET | (lock icon) stream.mattkc.com | /chat/emotes/ | jquery-3.6.1.min.js | html | 1.65 kB (raced)](images/protocolemoji.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea what this is supposed to be.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Protocol redirect connections

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea what this is supposed to be.

For the original two images, you had quoted them in plaintext, like something for accessibility, so that's just what I assumed and wrote all of the things in the image out.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to use captured web traffic in our documentation. I think it would be best if we told developers how to read the contents of the link and maybe have a table of emoji that we know of. Don't get me wrong though, I'm all for accessibility and I approve of making things easier to access. However, I want to make sure that the data at the link you provided is accessible to those reading the documentation, even if the contents of the link change.

protocol.md Outdated
[https://stream.mattkc.com/chat/emotes/]
https://stream.mattkc.com/chat/emotes/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this link supposed to be? Maybe we can have a table of all the known substitutions or instructions on how to read the data provided by the link?

Copy link

@L3m0n-Cao L3m0n-Cao Feb 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link is the information to convert text to the emojis

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can worry about that later. I'm going to make a docs webpage that github pages can host, so then we can add footnotes and cite our sources more cleanly

@GL513 GL513 requested a review from cbpudding February 5, 2023 09:57
README.md Outdated
ChatKC is different because it uses Google oAuth to authenticate users to the server after sign in.<br><br>
After the user is authenticated, they may chat on the MattKC site, or on an alternative, unofficial specialized client.<br><br>
Work is being done to fully reverse-engineer the ChatKC usage, so that others can make a decentralized network of ChatKC-style servers.<br><br>
ChatKC is a protocol that originated from [MattKC](https://www.youtube.com/@MattKC)'s website [here](https://stream.mattkc.com/) and reverse engineered by [Breadpudding](https://github.com/cbpudding) and [janKonku](https://github.com/zegfarce) on January 16th, 2023. After playing around with the protocol for hours, MattKC found us hanging out and decided to tweak the protocol a bit to make things easier for us to work with. This document describes the protocol that was created as a result.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good wording!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lol I just renamed a file, it's the original protocol.md file. The negative diff was mine

README.md Outdated
Comment on lines 402 to 403
![ Status | Method | Domain | File | Initiator | Type | Transfered | Size | 0ms
200 | GET | (lock icon) stream.mattkc.com | /chat/emotes/ | jquery-3.6.1.min.js:2 (xhr) | html | 1.65 kB | 7.43kB | 231ms ](images/protocolemoji.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't need this since we already have the URL above.

Comment on lines +398 to +400
The emoji system is still very unknown, but it seems that they are pulled from an array or table.

https://stream.mattkc.com/chat/emotes/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any thoughts on parsing the data given by Matt's server?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im guessing its just an alias kind of thing, you put in text and it replaces it with a file in realtime.

| Level | `!ban` | `!ipban` | `!mod` | `!rm` | `!unban` | `!unmod` |
| ----- | --------- | --------- | --------- | ----- | --------- | --------- |
| `0` | No | No | No | No | No | No |
| `50` | *Unknown* | *Unknown* | *Unknown* | Yes | *Unknown* | *Unknown* |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably get @janLuna to confirm which commands they have access to and if we're missing any.

@GL513 GL513 requested review from cbpudding and L3m0n-Cao February 6, 2023 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants