Giter Club home page Giter Club logo

polaris's Introduction

Polaris License: AGPL v3

Wiki - Discord - Forum

Polaris is a fork of the Baystation12 code branch for the game Spacestation13.


LICENSE

The code for Polaris is licensed under the GNU Affero General Public License version 3, which can be found in full in LICENSE-AGPL3.txt.

Code with a git authorship date prior to 1420675200 +0000 (2015/01/08 00:00) are licensed under the GNU General Public License version 3, which can be found in full in LICENSE-GPL3.txt.

All code whose authorship dates are not prior to 1420675200 +0000 is assumed to be licensed under AGPL v3, if you wish to license under GPL v3 please make this clear in the commit message and any added files.

If you wish to develop and host this codebase in a closed source manner you may use all code prior to 1420675200 +0000, which is licensed under GPL v3. The major change here is that if you host a server using any code licensed under AGPLv3 you are required to provide full source code for your servers users as well including addons and modifications you have made.

See here for more information.

All assets including icons and sound are under a CC BY-SA 3.0 license unless otherwise indicated.

GETTING THE CODE

The simplest way to obtain the code is using the github .zip feature.

Click here to get the latest code as a .zip file, then unzip it to wherever you want.

The more complicated and easier to update method is using git. You'll need to download git or some client from here. When that's installed, right click in any folder and click on "Git Bash". When that opens, type in:

git clone https://github.com/PolarisSS13/Polaris.git

(hint: hold down ctrl and press insert to paste into git bash)

This will take a while to download, but it provides an easier method for updating.

Once the repository is in place, run this command:

cd Polaris
git update-index --assume-unchanged polaris.int

Now git will ignore changes to the file polaris.int.

INSTALLATION

First-time installation should be fairly straightforward. First, you'll need BYOND installed. You can get it from here.

This is a sourcecode-only release, so the next step is to compile the server files. Open polaris.dme by double-clicking it, open the Build menu, and click compile. This'll take a little while, and if everything's done right you'll get a message like this:

saving polaris.dmb (DEBUG mode)

polaris.dmb - 0 errors, 0 warnings

If you see any errors or warnings, something has gone wrong - possibly a corrupt download or the files extracted wrong, or a code issue on the main repo. Ask on IRC.

Once that's done, open up the config folder. You'll want to edit config.txt to set the probabilities for different gamemodes in Secret and to set your server location so that all your players don't get disconnected at the end of each round. It's recommended you don't turn on the gamemodes with probability 0, as they have various issues and aren't currently being tested, so they may have unknown and bizarre bugs.

You'll also want to edit admins.txt to remove the default admins and add your own. "Game Master" is the highest level of access, and the other recommended admin levels for now are "Game Admin" and "Moderator". The format is:

byondkey - Rank

where the BYOND key must be in lowercase and the admin rank must be properly capitalised. There are a bunch more admin ranks, but these two should be enough for most servers, assuming you have trustworthy admins.

Finally, to start the server, run Dream Daemon and enter the path to your compiled polaris.dmb file. Make sure to set the port to the one you specified in the config.txt, and set the Security box to 'Trusted'. Then press GO and the server should start up and be ready to join.


UPDATING

To update an existing installation, first back up your /config and /data folders as these store your server configuration, player preferences and banlist.

If you used the zip method, you'll need to download the zip file again and unzip it somewhere else, and then copy the /config and /data folders over.

If you used the git method, you simply need to type this in to git bash:

git pull

When this completes, copy over your /data and /config folders again, just in case.

When you have done this, you'll need to recompile the code, but then it should work fine.


Configuration

For a basic setup, simply copy every file from config/example to config.


SQL Setup

The SQL backend for the library and stats tracking requires a MySQL server. Your server details go in /config/dbconfig.txt, and the SQL schema is in /SQL/tgstation_schema.sql. More detailed setup instructions arecoming soon, for now ask in our IRC channel.


IRC Bot Setup

Included in the repo is an IRC bot capable of relaying adminhelps to a specified IRC channel/server (thanks to Skibiliano). Instructions for bot setup are included in the /bot/ folder along with the bot/relay script itself.

polaris's People

Contributors

abi79 avatar anewbe avatar arokha avatar atermonera avatar atlantiscze avatar caelaislinn avatar ccomp5950 avatar cerebulon avatar cib avatar comma avatar datraen avatar ginjaninja32 avatar hawk-v3 avatar hubblenaut avatar itsanjonth avatar kelenius avatar leshana avatar magmaram avatar mechoid avatar mistakenot4892 avatar mloc avatar mwerezak avatar neerti avatar nullsnapshot avatar psiomegadelta avatar segrain avatar spookerton avatar tastyfish avatar wishmandible avatar yoshax avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

polaris's Issues

Medical Bay Front Door

It's missing a door access button for guests to use from the inside, in the event medical staff does not help them out.

Random shit mk1

Tool belt spawning in Chemistry.

More teleport bacons required on ship

Lights in maintenance every so often?

No captain's spare ID and shit like that

Reinforced windows Issue

Reinforced windows require four sheets of reinforced glass per placement. Still only drop one glass shard and rod. And pretty much means there is literally nothing you can make with 1-3 sheets of reinforced glass. This something we inherited from bay and is it something we can easily fix or live with?

Zones out of line.

Check zones:
-Bridge
-Hallway -- When evac is called, the flashing red leaks past certain areas. Zones on walls/etc.
-Locker room -- No red blinkey. But the evac zone beside it does. Looks odd.
-CMD Quarters - Fix bathroom zone.

Start of Round Shuttle Warnings

warning: shuttle with docking tag escape_shuttle could not find it's controller!
warning: shuttle with docking tag escape_pod_1 could not find it's controller!
warning: escape pod with station dock tag escape_pod_1_berth could not find it's dock target!
warning: shuttle with docking tag escape_pod_2 could not find it's controller!
warning: escape pod with station dock tag escape_pod_2_berth could not find it's dock target!
warning: shuttle with docking tag escape_pod_4 could not find it's controller!
warning: escape pod with station dock tag escape_pod_4_berth could not find it's dock target!
warning: shuttle with docking tag escape_pod_6 could not find it's controller!
warning: escape pod with station dock tag escape_pod_6_berth could not find it's dock target!
warning: shuttle with docking tag cryostorage_shuttle could not find it's controller!
warning: escape pod with station dock tag cryostorage_shuttle_berth could not find it's dock target!
warning: shuttle with docking tag large_escape_pod_1 could not find it's controller!
warning: escape pod with station dock tag large_escape_pod_1_berth could not find it's dock target!
warning: shuttle with docking tag large_escape_pod_2 could not find it's controller!
warning: escape pod with station dock tag large_escape_pod_2_berth could not find it's dock target!
warning: shuttle with docking tag centcom_shuttle could not find it's controller!
warning: shuttle with docking tag admin_shuttle could not find it's controller!
warning: shuttle with docking tag engineering_shuttle could not find it's controller!
warning: shuttle with docking tag mining_shuttle could not find it's controller!
warning: shuttle with docking tag research_shuttle could not find it's controller!
warning: shuttle with docking tag merc_shuttle could not find it's controller!

Grinders don't fully get rid of reagents

The grinders when tested with phoron in chem would grind reagents, but would leave them in the list. After grinding again, you don't get products, but the name goes away.

Mining smelting consoles not spawning correctly

In multiple attempts to make them work, the mining consoles for the smelter and the stacker seem to spawn in the map, but don't seem to be intractable with along with having no sprites. Alt clicking to try to select them does not even have them show up in the list of items on the tile.

Travis

Travis isn't working properly, something inside travis.yml is probably misconfigured. I'll have to poke at it later, so for now, Travis will report a failure for all new PRs.

Admin forced ERTs

A bit odd to join ERTs. Wasn't able to join an admin forced ERT until I messed with aghosting/jumping around.

The map lacks beacons for floorbots, beepsky

I forget the name of the item at the moment but essentially under the floor on say the Exodus there are little navbeacons beepsky, floorbots and I think mules use in order to path around the station and do their thing. Northern star lacks said beacons so the bots just sort of sit there all sad and confused unless a mess happens in a cleanbots sightrange/a criminal scum goes near beepsky.

Toxins Mixing Airlock does not cycle properly

Cycling to the mixing chamber it's self seems to work mostly fine, except that the external airlock doesn't work properly and must be forced to work properly. The dual end vent also does not seem to syphon.

Xenobiology airlocks don't cycle

The access cycler for xenobiology seems to not cycle either the interior nor exterior airlocks to it, not allowing anyone to enter the room.

Map is incomplete.

See title.
Map needs...

  • To be able to be loaded in DM.
  • To compile.
  • To be able to be run in dreamseeker.
  • Areas redone.
  • Tables/chairs/stools/other material-based structures to be redone.
  • Lights
  • Completed and tested wiring.
  • Completed and tested atmos and disposal pipes.
  • Station Z-level done.
  • Mining Z-level done.
  • Centcom Z-level done.
  • Decide if we want misc Z-levels.

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.