svrjs/svrjs-mod-starter
Template
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
The starter code and build system for SVR.JS mods
20 commits 1 branch 0 tags 379 KiB
JavaScript 100%
Find a file Use this template
Dorian Niemiec 36e4eae423 build: update SVR.JS installation script to work with zip archives without svr.compressed
2025-01-12 16:40:57 +01:00
.github/workflows Create main.yml 2024-08-27 07:22:03 +02:00
src feat: add example custom SVR.JS configuration validator 2024-12-10 19:09:31 +01:00
tests/utils Initial commit 2024-08-27 07:15:53 +02:00
.gitignore chore: ignore "svrjs" directory 2024-10-31 12:54:14 +01:00
esbuild.config.js build: add the development server 2025-01-02 13:44:43 +01:00
eslint.config.js Initial commit 2024-08-27 07:15:53 +02:00
jest.config.js Initial commit 2024-08-27 07:15:53 +02:00
LICENSE Initial commit 2024-08-27 07:15:53 +02:00
modInfo.json Initial commit 2024-08-27 07:15:53 +02:00
nodemon.json build: add the development server 2025-01-02 13:44:43 +01:00
package-lock.json build: add cleanup script 2025-01-02 14:03:49 +01:00
package.json build: add cleanup script 2025-01-02 14:03:49 +01:00
prettier.config.js build: add Prettier configuration 2024-12-31 09:17:32 +01:00
README docs: update the structure in README 2025-01-02 13:46:15 +01:00
svrjs.install.js build: update SVR.JS installation script to work with zip archives without svr.compressed 2025-01-12 16:40:57 +01:00

README 

This repository contains SVR.JS mod starter code and its build system
The mod will work for SVR.JS Nightly-GitNext.

Before doing anything, run "npm install".
To start the development server for the SVR.JS mod, run "npm run dev".
To build SVR.JS mod, run "npm run build".
To check SVR.JS mod code for errors with ESLint, run "npm run lint".
To fix and beautify SVR.JS mod code with ESLint and Prettier, run "npm run lint:fix".
To perform unit tests with Jest, run "npm test".

Structure:
 - dist - contains the built SVR.JS mod
 - src - contains SVR.JS mod source code
   - index.js - entry point
   - utils - utility functions
 - tests - Jest unit tests
   - utils - unit tests for utility functions
 - esbuild.config.js - the build script
 - eslint.config.js - ESLint configuration
 - jest.config.js - Jest configuration
 - modInfo.json - SVR.JS mod name and version
 - nodemon.json - Nodemon configuration
 - prettier.config.js - Prettier configuration
 - svrjs.install.js - SVR.JS installation script (SVR.JS is used by the development server)