Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leomotors committed Jul 13, 2023
1 parent 0e18223 commit 576d416
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 49 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ Notable Changes for Salim Bot will be noted here!
## [4.4.1600] - 2023-07-14

- refactor: move s-bot-framework to this repo
- refactor: Module Resolution `nodenext` (no more specifier flag)
- feat: Niwat TTS
- chore: update readme to reduce ความ病

## [4.2.1500] - 2023-07-06

Expand Down
84 changes: 35 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Salim Discord Bot V4
# Salim Discord Bot V๔

**Fun Fact**: This is my _most active_ project on GitHub

Salim Bot that is currently running of my friends server and is most active bot because it is auto triggered by พวกชังชาติ
Salim Bot is ~~currently running on my friends server~~ โดนเตะออกไปแล้ว น่ารำคาญเกิน
and is most active bot because it is auto triggered by พวกชังชาติ (เซิร์ฟของ @tinarskii)

## ✨ คุณสมบัติของบอทสลิ่ม

Expand All @@ -29,84 +28,71 @@ _และนอกจากจะเป็นฐานข้อมูลแล

- และฟีเจอร์อีกหลากหลายในเวอร์ชั่นก่อนๆ แต่ถูกตัดทิ้งเพราะคนทำ~~ชังชาติ~~ (จริงๆคือ refactor แล้วขี้เกียจเขียนใหม่)

- [NEW! ✨] Social Credit (Preview) Feature! Note: Prisma Engine and PostgreSQL required

## ⚙️ Under the Hood
- [NEW! ✨] Social Credit (Preview and Forever Preview) Feature! Note: Prisma Engine and PostgreSQL required

**WARNING: LEGACY CODE**
### 🌿 ก่อนใช้งาน

The Salim Bot _since April 2021_ has long history, of course it has big technical debt.
- Node.js ๑๘ (เลิกใช้ ๑๖ ได้แล้ว มันจะ EOL ละ ไอพวกไดโนเสาร์)

Each major version (except 3->4) is a rewrite
- PostgreSQL เราเลือกใช้ Postgres เพราะมีโลโก้เป็นรูปช้าง และช้างเป็นสัตว์ประจำชาติไทย

Currently, since version 3 Salim Bot is implemented by Salim Bot Framework, Available as _s-bot-framework_ on [npm](https://www.npmjs.com/package/s-bot-framework)
## 👨‍💻 วิธีใช้งาน

Version 4 includes Cocoa Discord Utils which take care of all Slash Commands
working with _legacy code_ underneath, Just like what Windows 11 is.

## [ใหม่!] ✨✨ Docker Image
In case you want to (not recommended)

คุณเองก็สามารถรันบอทสลิ่มได้ง่าย ๆ เพียงแค่รันคำสั่งนี้
- Clone or Download Repo

`docker pull ghcr.io/leomotors/salim-bot:latest`
`git clone https://github.com/Leomotors/Salim-Bot`

ตัวแปรสิ่งแวดล้อมที่จำเป็นต้องใช้ได้แก่ DISCORD_TOKEN และ DATABASE_URL
- Add required .env parameters

อย่าลืมเมล็ดฐานข้อมูลก่อนใช้งาน
- For the first time, do `pnpm install` to install dependencies, `pnpm prisma generate`
and `pnpm build` to build the bot.

## 🛣️ Previous Version: Legacy Salim Bot
- To start bot, do `pnpm start`

_warning_: Legacy Code
- To Stop Bot and Logout _properly_, Type `logout` in the Bot Console

- 2.2.431 [Last of V2](https://github.com/Leomotors/Salim-Bot/tree/52ec1163deec606aaeed0a6cd6968815edd3f94c) (Before implementing newly written [s-bot-framework](https://github.com/Leomotors/s-bot-framework))
- 1.15.248 [Last of V1](https://github.com/Leomotors/Salim-Bot/releases/tag/1.15.248) (Before rewritten in Version 2)
- 1.13.213 [Before TS ~~(ThakSin)~~](https://github.com/Leomotors/Salim-Bot/releases/tag/1.13.213) (JavaScript Version)
## [ใหม่!] ✨✨ Docker Image

_which each major version have some feature dropped, lmao_
คุณเองก็สามารถรันบอทสลิ่มได้ง่าย ๆ เพียงแค่รันคำสั่งนี้

### Not sponsored by
`docker pull ghcr.io/leomotors/salim-bot:latest`

`s-bot-framework` is specific for Salim Bot, but if you would want to create
normal Discord Bot, this is a good library =>
[Cocoa Discord Utils](https://github.com/Leomotors/cocoa-discord-utils)
ตัวแปรสิ่งแวดล้อมที่จำเป็นต้องใช้ได้แก่ `DISCORD_TOKEN` และ `DATABASE_URL`
อย่าลืมใส่ `SPEECH_KEY` และ `SPEECH_REGION` หากคุณต้องการใช้เสียงของนิวัฒน์

## 👨‍💻 To Implement
อย่าลืมเมล็ดฐานข้อมูลก่อนใช้งาน

In case you want to (not recommended)
## ⚙️ Under the Hood

- Clone or Download Repo
The Salim Bot _since April 2021_ has long history so it is filled with
legacy code + technical debt แบบเบิ้ม ๆ คือลือ.

`git clone https://github.com/Leomotors/Salim-Bot`
I won't fix old code unless it is needed for new feature.

- Add required .env parameters
## 🛣️ Previous Version: Legacy Salim Bot

- For the first time, do `pnpm install` to install dependencies
and `pnpm build` to build the bot.
_warning_: Legacy Code

- To start bot, do `pnpm start`
- 2.2.431 [Last of V2](https://github.com/Leomotors/Salim-Bot/tree/52ec1163deec606aaeed0a6cd6968815edd3f94c) (Before using [s-bot-framework](https://github.com/Leomotors/s-bot-framework) which were very awful)
- 1.15.248 [Last of V1](https://github.com/Leomotors/Salim-Bot/releases/tag/1.15.248) (Before rewritten in Version 2)
- 1.13.213 [Before TS where TS = ~~(ThakSin)~~ TypeScript](https://github.com/Leomotors/Salim-Bot/releases/tag/1.13.213) (JavaScript Version)

- To Stop Bot and Logout _properly_, Type `logout` in the Bot Console
_each major version have some feature dropped because I'm lazy to migrate_

### ⚠️ Caution

**Proceed at your own risk** Good Luck!

### 🌿 Prerequisites

- Latest nodejs 16+ (discord.js requirements)

- PostgreSQL 12 เราเลือกใช้ Postgres เพราะมีโลโก้เป็นรูปช้าง และช้างเป็นสัตว์ประจำชาติไทย

## 📚 Documents

As This Bot is powered by [s-bot-framework](https://github.com/Leomotors/s-bot-framework)

_again, warning_: Legacy Code

Documentation of this bot and full feature list of this bot is mostly explained in that framework's documentation, (if you can understand it)
ไม่ต้องมี เอาไปทำไรวะ

## 🙏 Spread the hype!

<img src="./images/long-live-hm-queen.jpg" alt="#ทรงพระเจริญ" width=400px>

<img src="./images/SAFETY_FIRST.jpg" alt="ปลอดภัยไว้ก่อน" width=400px>

0 comments on commit 576d416

Please sign in to comment.