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 변수 안에서의 명령어 추가를 권장합니다.