<commit_before>MOVED TO POLARISCORE https://github.com/PolarisTeam/PolarisCore








[![AGPL License](http://img.shields.io/badge/license-AGPL%20v3-red.svg?style=flat-square)](http://opensource.org/licenses/AGPL-3.0) 
[![Build status](https://ci.appveyor.com/api/projects/status/3ltwll4bck12ey0t?svg=true)](https://ci.appveyor.com/project/cyberkitsune/polarisserver)

`Current PSO2 Version: 4.0201.0`


## Table of Contents

* [What is it?](#what-is-it)
* [Installation](#installation)
  * [Building The Latest Version](#building-the-latest-version)
  * [Downloading The Latest Version](#downloading-the-latest-version)
* [Documentation](#documentation)
* [Licensing](#licensing)
  * [Third Party Licenses](#third-party-licenses)
* [Contributing and Feedback](#contributing-and-feedback)
  * [Core Maintainers](#core-maintainers)

## What is it?
`Polaris Private Server` is an open source game private server for the Japanese MMORPG Phantasy Star Online 2. It is currently work-in-progress alpha, under heavy development and is not yet recommended for production use.

## Installation
As `Polaris Private Server` is a work-in-progress there is no set way of installaing and running, in future releases we hope to have this information stored in an INSTALL file. Until then you can either build or download and run the latest version.

### Building The Latest Version
For the time being, we only support using mono in order to build Polaris.
You need to have MonoDevelop 4 / Xamarin studio installed. You also need the Mono runtime, even on Windows!
After installing MD / Xamarin and setting up the Mono runtime, open the solution and build!
In the future we will hopefully have a buildserver, xbuild / msbuild support and other fancy things.

### Downloading The Latest Version
As the `Polaris Private Server` is a work-in-progress alpha, you can find the latest unstable built version here @ [AppVeyor](https://ci.appveyor.com/project/cyberkitsune/polarisserver/build/artifacts)

### Documentation
All available documentation for the server can be found on the project wiki @ [pso2proxy.cyberkitsune.net/wiki](http://pso2proxy.cyberkitsune.net/wiki)

## Licensing
All code is licensed under the
[AGPL](https://github.com/PolarisTeam/PolarisServer/blob/master/LICENSE), v3 or later.

### Third Party Licenses
    Copyright (c) 2006 <NAME> <<EMAIL>> (jBCrypt)
    Copyright (c) 2013 <NAME> (.Net port)

    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

## Contributing and Feedback
Currently, you can contribute to the Polaris Private Server project by:
* Submitting a detailed [issue](https://github.com/PolarisTeam/PolarisServer/issues/new).
* [Forking the project](https://github.com/PolarisTeam/PolarisServer/fork), and sending a pull request back to for review.

There is an IRC channel `#pso2` on BadnikZone (irc.badnik.zone:6667), for talking directly
with testers and developers (when awake and present, etc.). However any questions pertaining to the release dates or asking for hacks will be ignored, and you may be banned from the channel.

### Core Maintainers

* "cyberkitsune" <https://github.com/cyberkitsune>
* "VariantXYZ" <https://github.com/VariantXYZ>
* "KeyPhact" <https://github.com/KeyPhact>
* "Kyle873" <https://github.com/Kyle873>
* "LightningDragon" <https://github.com/LightningDragon>
* "SonicFreak94" <https://github.com/SonicFreak94>
* "Treeki" <https://github.com/Treeki><commit_msg>Update README, also I don't maintain anything here<commit_after>MOVED TO POLARISCORE https://github.com/PolarisTeam/PolarisCore








[![AGPL License](http://img.shields.io/badge/license-AGPL%20v3-red.svg?style=flat-square)](http://opensource.org/licenses/AGPL-3.0) 
[![Build status](https://ci.appveyor.com/api/projects/status/3ltwll4bck12ey0t?svg=true)](https://ci.appveyor.com/project/cyberkitsune/polarisserver)

## Table of Contents

* [What is it?](#what-is-it)
* [Installation](#installation)
  * [Building The Latest Version](#building-the-latest-version)
  * [Downloading The Latest Version](#downloading-the-latest-version)
* [Documentation](#documentation)
* [Licensing](#licensing)
  * [Third Party Licenses](#third-party-licenses)
* [Contributing and Feedback](#contributing-and-feedback)
  * [Core Maintainers](#core-maintainers)

## What is it?
`Polaris Private Server` is an open source game private server. It is currently work-in-progress alpha, under heavy development and is not yet recommended for production use.

## Installation
As `Polaris Private Server` is a work-in-progress there is no set way of installaing and running, in future releases we hope to have this information stored in an INSTALL file. Until then you can either build or download and run the latest version.

### Building The Latest Version
For the time being, we only support using mono in order to build Polaris.
You need to have MonoDevelop 4 / Xamarin studio installed. You also need the Mono runtime, even on Windows!
After installing MD / Xamarin and setting up the Mono runtime, open the solution and build!
In the future we will hopefully have a buildserver, xbuild / msbuild support and other fancy things.

### Downloading The Latest Version
As the `Polaris Private Server` is a work-in-progress alpha, you can find the latest unstable built version here @ [AppVeyor](https://ci.appveyor.com/project/cyberkitsune/polarisserver/build/artifacts)

### Documentation
All available documentation for the server can be found on the project wiki @ [pso2proxy.cyberkitsune.net/wiki](http://pso2proxy.cyberkitsune.net/wiki)

## Licensing
All code is licensed under the
[AGPL](https://github.com/PolarisTeam/PolarisServer/blob/master/LICENSE), v3 or later.

### Third Party Licenses
    Copyright (c) 2006 <NAME> <<EMAIL>> (jBCrypt)
    Copyright (c) 2013 <NAME> (.Net port)

    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

## Contributing and Feedback
Currently, you can contribute to the Polaris Private Server project by:
* Submitting a detailed [issue](https://github.com/PolarisTeam/PolarisServer/issues/new).
* [Forking the project](https://github.com/PolarisTeam/PolarisServer/fork), and sending a pull request back to for review.

There is an IRC channel `#pso2` on BadnikZone (irc.badnik.zone:6667), for talking directly
with testers and developers (when awake and present, etc.). However any questions pertaining to the release dates or asking for hacks will be ignored, and you may be banned from the channel.

### Core Maintainers

* "cyberkitsune" <https://github.com/cyberkitsune>
* "KeyPhact" <https://github.com/KeyPhact>
* "Kyle873" <https://github.com/Kyle873>
* "LightningDragon" <https://github.com/LightningDragon>
* "SonicFreak94" <https://github.com/SonicFreak94>
* "Treeki" <https://github.com/Treeki>
{'fraction_non_alphanumeric': 0.09489141164856861, 'fraction_numerical': 0.010118460019743336, 'mean_word_length': 4.7769066286528865, 'pattern_counts': {'":': 0, '<': 24, '<?xml version=': 0, '>': 24, 'https://': 27, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4751823', 'n_tokens_mistral': 2475, 'n_tokens_neox': 2327, 'n_words': 892}