Үлес қосу

Технологиялық стек пен жоба туралы

Мұнда біз осы жобаның құралдар тізбегі мен орындалу ортасына шолу жасаймыз

Бүкіл жоба үшін бізде бар:

• Node.js >=20. Негізгі кітапханалардың базалық ортасы.
• Electron 29. Лаунчердің нақты орындалу ортасы.
• pnpm. Monorepo пакеттерін басқару үшін қолданылады.
• TypeScript. Бүкіл жобада мүмкіндігінше TypeScript қолданылады.

Негізгі процесс үшін (Electron), біз келесіні қолданамыз:

• esbuild. Негізгі процесс TypeScript-ін құрастыру үшін esbuild қолданамыз.

Рендерер жағында, яғни таза фронтенд:

• Vue. Пайдаланушы интерфейстерін құру үшін қолданылады.
• Vite. Құрастыру жүйесі ретінде қолданылады.
• Vuetify. Компонент кітапханасы ретінде қолданылады.
• Vue Composition API. Vue 2 үшін композициялық API көпірі. Vuetify Vue 3-ке жаңартылған кезде, Vue де жаңартылады және бұл жойылады.

Жоба құрылымы мен дизайны

Толық дизайн туралы қараңыз. Бұл жағдайлардың 90%-ын қамтуы керек!

Үлес қосу

Жобаны ашу үшін VSCode қолдануды қатты ұсынамыз.

Бастау

Клондау

Жобаны --recurse-submodules флагымен клондаңыз.

git clone --recurse-submodules https://github.com/Voxelum/x-minecraft-launcher

Егер сіз --recurse-submodules флагын қосуды ұмытып кетсеңіз, git субмодульді қолмен инициализациялап, жаңартуыңыз керек.

git submodule init
git submodule update

Орнату

Жобаны pnpm көмегімен орнатыңыз:

pnpm install

Қытайда тәуелділіктерді (мысалы, Electron) баяу орнату мәселесінің шешімі

Git bash терезеңізді ашып, pnpm i алдында registry=https://registry.npm.taobao.org electron_mirror="https://npm.taobao.org/mirrors/electron/" қосыңыз. Alibaba ұсынған Қытай npm және Electron айнасын қолданыңыз.

Соңғы команда:

registry=https://registry.npm.taobao.org electron_mirror="https://npm.taobao.org/mirrors/electron/" pnpm i

Орта айнымалыларын орнату

xmcl-electron-app ішінде .env файлын жасау арқылы CURSEFORGE_API_KEY орнатуыңыз керек. Бұл .env файлы .gitignore файлына қосылған.

ЕСТЕ САҚТАҢЫЗ

CURSEFORGE API KEY КІЛТІҢІЗДІ ЖАРИЯЛАМАҢЫЗ

Лаунчерді бастау

Сонда сіз лаунчерді іске қоса аласыз

VSCode үшін

Run and Debug бөліміне өтіп, электронды бастау үшін Electron: Main (launch) профилін қолданыңыз. (F5 пернесі)

VSCode емес редакторлар үшін

Бір терминалды ашыңыз

# UI үшін dev серверін бастау
npm run dev:renderer

Басқа терминалды ашыңыз

# Негізгі процесс кодын бақылауды бастау
npm run dev:main