Dinhero21/modular-minecraft-proxy
1
0
Fork 0
mirror of https://github.com/DinheroDevelopmentGroup/modular-minecraft-proxy.git synced 2024-11-23 07:38:18 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Funny Files

Browse source
This commit is contained in:
Dinhero21 2024-01-05 18:46:44 -03:00
parent 89c432e70f
commit ff3c30a482
12 changed files with 5404 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.editorconfig Normal file
View file

@ -0,0 +1,9 @@
root = true
[*]
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
indent_size = 2

19
.eslintrc.json Normal file
View file

@ -0,0 +1,19 @@
{
"env": {
"es2021": true,
"node": true
},
"extends": [
"standard-with-typescript",
"plugin:require-extensions/recommended"
],
"plugins": [
"require-extensions"
],
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"project": "tsconfig.json"
},
"rules": {}
}

21
.swcrc Normal file
View file

@ -0,0 +1,21 @@
{
"$schema": "https://json.schemastore.org/swcrc",
"jsc": {
"parser": {
"syntax": "typescript",
"tsx": false,
"decorators": true,
"dynamicImport": false
},
"transform": {
"useDefineForClassFields": false
},
"externalHelpers": true,
"target": "es5",
"loose": true
},
"module": {
"type": "es6"
},
"minify": false
}

38
README.md
View file

@ -1,2 +1,36 @@
# modular-minecraft-proxy
Lego Minecraft
# MMP
- Modular Minecraft Proxy
# How does this differ from other proxies (such as SMP)?
## Type Safety
Instead of JavaScript, TypeScript is used which allows for type checking of the code and less bugs.
## Multi-Threading
For every client that connects a new thread is created.
While also offering minimal performance gains (as there probably isn't (and shouldn't) be ever more then one client) makes it so that program instances client-based instead of being shared between all clients.
This makes a Singleton-like architecture possible without needing to worry about multiple instances of the same plugin and explicit declaration of dependencies.
Data can be sent between instances via [IPC](https://en.wikipedia.org/wiki/Inter-process_communication).
## Modularity
Other proxies came pre-installed with plugins which most time were private meaning that you couldn't share the project with the public.
They also had a monolithic boilerplate-y settings file with many placeholders.
This repo is only the loader which has only the responsibility of proxy-ing the connection, manipulating packets, managing threads and loading modules.
## Installation, Development and Distribution
The dynamic nature of the project will make it very easy to install, develop and distribute modules.
To install simply `cd` into to the `modules` directory create add the module(s) there (via `git clone` or similar).
To develop simply create a sub-directory under the `modules` directory, you can test your module by running the loader.
To distribute simply create a repository in the `modules` directory and then share it via something like [github](https://github.com/).

5039
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

41
package.json Normal file
View file

@ -0,0 +1,41 @@
{
"name": "modular-minecraft-proxy",
"version": "1.0.0",
"description": "Lego Minecraft",
"main": "index.js",
"type": "module",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "scripty",
"watch:build": "scripty",
"run": "scripty",
"watch:run": "scripty",
"watch": "scripty"
},
"keywords": [],
"author": "",
"license": "ISC",
"config": {
"scripty": {
"parallel": true,
"path": "script"
}
},
"devDependencies": {
"@swc/cli": "^0.1.63",
"@swc/core": "^1.3.102",
"@types/node": "^20.10.6",
"@typescript-eslint/eslint-plugin": "^6.17.0",
"@typescript-eslint/parser": "^6.17.0",
"eslint": "^8.56.0",
"eslint-config-standard-with-typescript": "^43.0.0",
"eslint-plugin-import": "^2.29.1",
"eslint-plugin-n": "^16.6.1",
"eslint-plugin-promise": "^6.1.1",
"nodemon": "^3.0.2",
"typescript": "^5.3.3"
},
"dependencies": {
"minecraft-protocol": "^1.26.5"
}
}

3
script/build.sh Executable file
View file

@ -0,0 +1,3 @@
#!/usr/bin/env bash
swc src -d dist $@

3
script/run.sh Executable file
View file

@ -0,0 +1,3 @@
#!/usr/bin/env bash
node dist/index.js

3
script/watch/build.sh Executable file
View file

@ -0,0 +1,3 @@
#!/usr/bin/env bash
./script/build.sh $@ --watch

3
script/watch/run.sh Executable file
View file

@ -0,0 +1,3 @@
#!/usr/bin/env bash
nodemon --watch dist --exec "./script/run.sh $@"

112
src/index.ts Normal file
View file

@ -0,0 +1,112 @@
import { createClient, createServer, states } from 'minecraft-protocol'
interface RawPacket {
name: string
data: unknown
}
const VERSION = '1.19.4'
const SERVER = {
host: '127.0.0.1',
port: 25565,
keepAlive: false,
version: VERSION
}
const TARGET = {
host: 'kaboom.pw',
port: 25565,
keepAlive: false,
username: 'Player137',
version: VERSION
}
const server = createServer(SERVER)
server.on('login', client => {
const target = createClient(TARGET)
client.on('end', reason => {
console.info('Client disconnected:', reason)
target.end(reason)
})
target.on('end', reason => {
console.info('Target disconnected:', reason)
client.end(reason)
})
client.on('error', error => {
console.error('Client error:', error)
})
target.on('error', error => {
console.error('Target error:', error)
})
client.on('packet', (data, meta) => {
if (meta.state !== states.PLAY) return
sendTargetPacket({
name: meta.name,
data
})
})
target.on('packet', (data, meta) => {
if (meta.state !== states.PLAY) return
sendClientPacket({
name: meta.name,
data
})
})
const CLIENT_QUEUE: RawPacket[] = []
const TARGET_QUEUE: RawPacket[] = []
client.on('state', state => {
if (state !== states.PLAY) return
for (const packet of CLIENT_QUEUE) client.write(packet.name, packet.data)
CLIENT_QUEUE.length = 0
})
target.on('state', state => {
if (state !== states.PLAY) return
for (const packet of TARGET_QUEUE) target.write(packet.name, packet.data)
TARGET_QUEUE.length = 0
})
function sendClientPacket (packet: RawPacket): void {
if (client.state !== states.PLAY) {
CLIENT_QUEUE.push(packet)
return
}
client.write(
packet.name,
packet.data
)
}
function sendTargetPacket (packet: RawPacket): void {
if (target.state !== states.PLAY) {
TARGET_QUEUE.push(packet)
return
}
target.write(
packet.name,
packet.data
)
}
})

115
tsconfig.json Normal file
View file

@ -0,0 +1,115 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "esnext", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "nodenext", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
"moduleResolution": "nodenext", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": [
"src/**/*"
],
"exclude": [
"node_modules"
]
}