node-hill-mplayer
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

What is this?

A Brick Hill legacy server written from the ground up in Node.js. (Custom Build by Malte0621)

What is the difference?

The difference between this and the normal node-hill is the fact that this custom build has featrues that does not exists in the normal node-hill nor client.

Current custom-build features:

  • Sounds
  • Full XYZ rotation axis support (This means your maps CAN to follow the new brk format., replace +ROT with +ROT 0,0,)
  • Replicated physics
  • GUIs
  • Materials (This means your maps CAN to follow the new brk tag., +MAT . Example: +MAT bricks)
  • Textures (This means your maps CAN to follow the new brk tag., +*_TEXTURE . Example: +TOP_TEXTURE https://example.com/texture.png)
  • Tweens (tweening) - for bricks

What does this do?

It allows you to host Brick Hill servers efficiently, and headlessly (VPS hosting, etc). It comes with a fully-packed scripting API that lets you do things the legacy server normally couldn't do.

It can load .brk files to the client extremely fast, but at the same time being memory and CPU efficient. Allowing for long-term 24/7 hour hosting.

What does this NOT do?

This does not provide any additional functionality to the legacy client.

ie. The client will not gain any FPS improvements.

Automatic Client Installation:

Download the client installer/uninstaller from here, then run it as admin and click the big install button.

MANUAL Client Installation:

  1. Download the auto updater / launcher from here and download the required sound dll from here.

  2. Put the sound dll in %appdata%\Brick Hill\ and put the launcher in C:\Program Files (x86)\Brick Hill, make sure to rename the old one first. (Do not replace old one, use it as a backup.)

  3. Now simply join a game that runs my server. (or if still working, other servers too.)

Errors and fixes:

Error defining an external function. : Restarting your computer usually fixes this. (It is a dll load error caused by windows.) Error defining an external function. : Could also be caused by a windows issue that doesn't fix when you reboot, if that's the case. Make a directory in %appdata%\Brick Hill call it overrides and create a file called nosounds (or download the file here and put it in the overrides folder. (Or uninstall the client .-., and reutrn to normal bh.. :/)

Installation:

  1. Download Node.js 8 or above at https://nodejs.org/en/download/

  2. Download and extract the template here.

  3. Open the extracted folder in the file explorer, and in the top bar type "cmd" and press enter.

  4. Install node-hill-mplayer using the command node-hill-mplayer@latest in cmd/terminal (make sure your're in the template folder with cmd/terminal.), as this will install the needed dependencies for node-hill to function.

  5. Edit the start.js file to fill in your appropriate server information.
    You will need to add your host key for the set you want to host. This can be found under the set's settings page.

  6. Finally, start your server by launching launch_server.bat or by running node ./start.js.

Additional information

You must port forward if you want other players to be able to play your game. The recommended port for Brick Hill is: 42480.

You are able to bundle your map/scripts into a single .bbrk file by launching your server with the --bundle option.

For example: node .\start.js --bundle

For more information on bundling check out nh-bundle.

Documentation

Can be found here: https://example.com/.

Readme

Keywords

none

Package Sidebar

Install

npm i node-hill-mplayer

Weekly Downloads

1

Version

0.1.0

License

MIT

Unpacked Size

542 kB

Total Files

109

Last publish

Collaborators

  • malte0621