UMUX User Guidelines - HonestSquare/UMUX GitHub Wiki
๊ฐ์
- UMUX ์ฌ์ฉ์ ๊ฐ์ด๋๋ผ์ธ์ ๋๋ค.
- v1.20
๊ธฐํธ | ์ค๋ช | ๋น๊ณ |
---|---|---|
โฒ | ๋ฐ๋ฅด๋ ๊ฑธ ๊ถํ๋ฉฐ ์๋ฌด์ ๋๋ค. | ๊ฐ์ ์ฌํญ |
โณ | ๋ฐ๋ฅด๋ ๊ฑธ ๊ถํ๋ ์๋ฌด๋ ์๋๋๋ค. | ๊ถ์ฅ์ฌํญ |
1. ์์๋ฌผ์ ๋ํ ๊ถ๋ฆฌ ํ๊ธฐ
- ๋ณธ ์์ค ์ฝ๋๋ ๋ค์๊ณผ ๊ฐ์ ์ฌํญ์ ๊ธฐ์ฌํด์ผ ํฉ๋๋ค.
1-1. โฒ์ ์๋ฌผ์ ๊ธฐ๋ฐ์ด UMUX์์ ๊ธฐ๋ฐ์ ๋์์์ ํ๊ธฐ
- ๋ค์๊ณผ ๊ฐ์ด ์์ฑํ๋ฉด ๋ฉ๋๋ค
// 3.0.0
NC.announce(NC.info() + "ํซํด ๋ด๋ฐฉ์
๋๋ค. " + "(Base on UMUX)", null, "green", 5, 3);
NC.info(DESCRIPTION + SYS.newLine + "๋ฆด๋ฆฌ์ค ๋ ์ง: 2021.03.22" + ' | ' + SYS.showInfo()`
// 4.0
findInfo(){
return NC.fmtStr([["์๋ฒ ๋ฒ์ : %d", "UMUX ๋ฒ์ : %d", "UMUX ๋ณด์ ํจ์น ์์ค: %d"
].join(" | "), "Powered by UMUX"].join(newLine), [this._versionRoom, this._versionUMUX, this._securityPatchLevel]);
}
// 5.0
findInfo(){
return NC.fmtStr([["์๋ฒ ๋ฒ์ : %1", "%0 ๋ฒ์ : %2", "%0 ๋ณด์ ํจ์น ์์ค: %3"
].join(" | "), "Powered by %0"].join(newLine), ["UMUX", this.verRoom, this.verUMUX, this.scrPtcLvl]);
}
2. ์์ ๋ฐ ๋ฐฐํฌ
2-1. ์์ ์
2-1-1. โฒ์ฌ๋ฐฐํฌ
- ๋ณธ ์์๋ฌผ์ ์ค์ง ์ฌ๊ธฐ์ ์ ๋ก๋ํฉ๋๋ค.
- ๋จ ๋งํฌ๋ฅผ ํตํ ๊ฐ์ ์ ์ธ ๊ณต์ ๋ ํ์ฉํฉ๋๋ค.
2-2. ์์ ํ
2-2-1. โณ์ฝ๋ ์์ฑ ๋ฐ ํธ์ง
2-2-1-1. โฒ์ด๋ฏธ ์์ฑ๋ ํด๋์ค ๋๋ ๋ฉ์๋, ๋ณ์ ์ด๋ฆ ๋ณํ
- ์์ค ์ฝ๋์ ์ด๋ฏธ ์์ฑ๋ ํด๋์ค ๋๋ ๋ฉ์๋, ๋ณ์์ ์ด๋ฆ์ ๋ณํํ์ง ๋ง์์ผ ํฉ๋๋ค.
// 5.0
const CS = new ChatManager(
...
);
// ์๋ฅผ ๋ค์ด CS๋ฅผ TEST๋ก ์ด๋ฆ์ ๋ณํํฉ๋๋ค
const TEST = new ChatManager(
...
);
- ์์ ๊ฐ์ด ๋ณํํ์ง ๋ง์ญ์์ค.
2-2-1-2. ์ถ๊ฐ ๊ฐ์ฒด ๋์
- ๋จ ์์๋ก ์์ฑํ ๊ฐ์ฒด์ ๋์ ์ ํ์ฉํฉ๋๋ค.
// 5.0
const CS = new ChatManager(
...
);
// TEST ์์๋ฅผ ์ ์ธ๊ณผ ๋์์ CS๋ก ์ด๊ธฐํ ํฉ๋๋ค
const TEST = CS;
2-2-2. โฒ์ธ๊ตญ์ด ๋ฒ์ญ
- ํ๊ตญ์ด ์ด์ธ์ ๋ค๋ฅธ ์ธ์ด๋ฅผ ๊ธฐ๋ฐ์ผ๋ก ์ด์ฉํ๋ ๊ฒฝ์ฐ,
- ์ฌ์ฉ์๊ฐ ํ๊ตญ์ด๋ฅผ ์ ํํ ์ ์๋ ๊ธฐ๋ฅ์ ์ ๊ณตํ๊ฑฐ๋
- ํ๊ตญ์ด ๊ธฐ๋ฐ์ ์์คํ ์ด ์กด์ฌํด์ผ ํฉ๋๋ค
2-2-3. โณ๋ฐฐํฌ
- ์์ค ์ฝ๋๋ฅผ ์์ ํ ๋ฐฐํฌํ๋ ๊ฒฝ์ฐ, ๊ฐ๋ฅํ๋ฉด ์์๋ฌผ ์ถ์ฒ๋ฅผ ๋จ๊ธฐ๋ ๊ฒ์ด ์ข์ต๋๋ค.
3. ๊ธฐ๋ณธ ๋ด์ฅ ๋งต
3-1. CROP-MK(API ๋ ๋ฒจ 8 ์ด์ )
- UMUX์ ํ์ฌ๋ ๊ธฐ๋ณธ ๋งต์ ๋๋ค.
- UMUX ์ด์ธ์ ์ด๋ ํ ์ฉ๋์ ์์ /์ฌ๋ฐฐํฌ/์ฌ์ฉ์ด ๊ฐ๋ฅํฉ๋๋ค.
- ์์ /์ฌ๋ฐฐํฌ/์ฌ์ฉ์ ๋ฐ๋ฅธ ์ฑ ์์ ๋ชจ๋ ์ด์ฉ์ ๋ณธ์ธ์๊ฒ ์์ต๋๋ค.
3-2. CROP-900M(API ๋ ๋ฒจ 9 ์ดํ)
- UMUX์ ํ์ฌ๋ ๊ธฐ๋ณธ ๋งต์ ๋๋ค.
- UMUX ์ด์ธ์ ์ด๋ ํ ์ฉ๋์ ์์ /์ฌ๋ฐฐํฌ/์ฌ์ฉ์ด ๊ฐ๋ฅํฉ๋๋ค.
- ์์ /์ฌ๋ฐฐํฌ/์ฌ์ฉ์ ๋ฐ๋ฅธ ์ฑ ์์ ๋ชจ๋ ์ด์ฉ์ ๋ณธ์ธ์๊ฒ ์์ต๋๋ค.
4. ๊ถํ ๋ฐ ๊ด๋ฆฌ์
4-1. โฒ์๊ตฌ ํด์ฅ
- ๋ช ๋ น์ด๋ฅผ ํตํ ์ง์ ์ ์ธ ์๊ตฌ ํด์ฅ ์ฒ๋ฆฌ๋ ๊ธ์ง๋ฉ๋๋ค.
4-2. โฒ์ํผ ๋ธ๋๋ฆฌ์คํธ
- ๋ช ๋ น์ด๋ฅผ ํตํ ์ง์ ์ ์ธ ์ํผ ๋ธ๋๋ฆฌ์คํธ ์ถ๊ฐ ๋ฐ ๋ฑ๋ก ์ฒ๋ฆฌ๋ ๊ธ์ง๋ฉ๋๋ค.
5. ์์คํ
5-1. โฒUMUX ๋ฒ์
- UMUX์ ์์คํ ์์ญ์ด๋ฏ๋ก ์์๋ก ๋ฒ์ ๋ช ์ ๋ณ๊ฒฝํ๊ฑฐ๋ ๋ณํํ์ง ๋ง์ญ์์ค.
5-2. โฒ๋ณด์ ํจ์น ์์ค
- โฒUMUX์ ์์คํ ์์ญ์ด๋ฏ๋ก ์ ๋ ์์๋ก ์์ค๋ช ์ ๋ณ๊ฒฝํ๊ฑฐ๋ ๋ณํํ์ง ๋ง์ญ์์ค.
5-2-1. โณ์ ๋ฐ์ดํธ(API ๋ ๋ฒจ 10 ์ด์ )
- โณ์๋ฒ ๋ฐ ๋ณด์ ์ต์ ํ ๊ฐ์ ์ ์ํด ๊ฐ๋ฅํ๋ฉด ์ต์ ๋ณด์ ํจ์น๋ฅผ ์ ์ฉํ๋ ๊ฒ ์ข์ต๋๋ค.
6. ๊ธฐํ
6-1. โณ๋ช ๋ น์ด ์ถ๊ฐ(API ๋ ๋ฒจ 8 ์ด์ )
๋ช ๋ น์ด๋ commands ๋ณ์ ์์์ ์ถ๊ฐํ๋ ๊ฑธ ๊ถ์ฅํฉ๋๋ค.
6-2. ๋ช ๋ น์ด ์ถ๊ฐ(API ๋ ๋ฒจ 9 ์ดํ)
internalCommands
6-2-1. โฒ๋ช
๋ น์ด๋ internalCommands
์์ ์์์์ ๋ช
๋ น์ด ์ถ๊ฐ ๋ฐ ์ญ์ ๋ ๊ธ์ง๋ฉ๋๋ค.
standardCommands
6-2-1. โณ๋ช
๋ น์ด๋ internalCommands
์์ ์์์์ ๋ช
๋ น์ด ์ถ๊ฐ ๋ฐ ์ญ์ ๋ ๊ถ์ฅํ์ง ์์ต๋๋ค.
customCommands
6-2-1. โณcustomCommands
๋ณ์ ์์์์ ๋ช
๋ น์ด ์ถ๊ฐ๋ฅผ ๊ถ์ฅํฉ๋๋ค.