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 ์ดํ›„)

6-2-1. โ–ฒinternalCommands

๋ช…๋ น์–ด๋Š” internalCommands ์ƒ์ˆ˜ ์•ˆ์—์„œ์˜ ๋ช…๋ น์–ด ์ถ”๊ฐ€ ๋ฐ ์‚ญ์ œ๋Š” ๊ธˆ์ง€๋ฉ๋‹ˆ๋‹ค.

6-2-1. โ–ณstandardCommands

๋ช…๋ น์–ด๋Š” internalCommands ์ƒ์ˆ˜ ์•ˆ์—์„œ์˜ ๋ช…๋ น์–ด ์ถ”๊ฐ€ ๋ฐ ์‚ญ์ œ๋Š” ๊ถŒ์žฅํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

6-2-1. โ–ณcustomCommands

customCommands ๋ณ€์ˆ˜ ์•ˆ์—์„œ์˜ ๋ช…๋ น์–ด ์ถ”๊ฐ€๋ฅผ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.