Giter Site home page Giter Site logo

scpslminimap's Introduction

SERVER SIDE MINIMAP

KNOWN ISSUES

Map doesn't load until a full server restart - Fixed

Center is broken

Some rooms might not look right

What is it?

Glad you asked, it is a simple, yet configurable in-browser minimap for SCP:SL.

Isn't this cheating?

I don't consider it cheating as this only sends what the server owner/admin approves of sending, and it only will work on servers that support the plugin.

Contact

If you find a bug in the code or a security glitch, please message me on discord, Virtual#7802, or email me at [email protected]

How do I put this on my server?

Actually, it isn't that simple as drag-n-drop the .dll into the SMod2 plugins folder. You must setup the node.js server as well.

To start, install node.js (google it), and then install the packages in the directory Mod8Server/ using npm.

npm install --save socket.io

npm install --save express

Then, close your SCP:SL server and put the Mod8.dll into the sm_plugins/ folder in the SCP:SL server files.

If you are playing with friends/want to make it public, make sure to open port 8000.

Next, in the Mod8Server/ folder run the command node server.js. It should say listening on port *:8000, Server listening on 127.0.0.1:8080 and nothing else for the time being.

Now that the node.js server is running, you may now start the SCP:SL server. It should say from my plugin Connecting to node.js server and hopefully no errors. If there are errors, it probably couldn't connect to the node.js server. SCP:SL should start normally.

How do I change the configurations?

There are some lines of code in the Mod8Server/server.js file at the top that have descriptions of what they do and what values can be set. The values can be changed at runtime by typing in the node.js server console the variable name followed by the new value (<varname> <newvalue>). It should say <varname> = <newvalue>.

How do I use this in-game?

Simple, press the ~ key on your keyboard when on the server in-game (not in the server) and you should see something along the lines of Your SteamID is: <yoursteamidhere> and Your new key is: <random 5 character code>.

Then goto <yourwebsite.example>:8000 or yourServerIP:8000 in a modern web browser, and enter your steam64id and the 5 character key. You can save the steam64id into cookies if you wish to.

From here, you should see a map, some navigation buttons, yourself, and maybe other players or a ring of where an SCP might be.

Notes

Why is there a bunch of commented code in Mod8.cs?

Because I was too lazy to remove it all, and it was mostly for debugging.

Why is Root_X not the right room ingame?

Because the names on the map are ripped right from the game. I have no control over how the SCP:SL devs name the rooms.

scpslminimap's People

Contributors

virtualbrightplayz avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

scpslminimap's Issues

EXILED

I know its a plugin from 2 years ago, but you also created a lot of plugins based on EXILED. Is there any way this plugin can work on EXILED? Or would it have to be rewritten?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.