Git Product home page Git Product logo

oasis's Introduction

Oasis

Live Map for Farming Simulator 22

While playing Farming Simulator 19, i was wondering if it's possible to have some kind of "out of game" live map.
After some quick research (basically clicking through the dedicated server administration, i found some xml files with interesting informations.
And here we are... "Oasis" a Farming Simulator Live Map.

How-To: Contribute new Translations

  1. Create a new branch called "Translation-XX" and replace XX with the corresponding language code (eg. "Translation-DE" for german or "EN" for english)
  2. Duplicate one of the existing language files (best "en.json" or "de.json") in the "server/locales" folder and rename it with the same language code (eg "de")
  3. Translate :)
  4. Commit your translations and create a pull-request and add msdigital as a reviewer
  5. Done

Thanks for your contribution! I will check the translations and add them to a release package from time to time.

Prerequisites

  • node > 16.16.0
  • npm > 8.11.0
  • Farming Simulator 22 Server ;)

Works best on linux hosts ;)

Run Oasis locally

Installation

  1. Get the latest relase version
  2. Extract zip file
  3. Open a new terminal inside the folder
  4. Run npm install and let npm do the rest :)

Run Oasis

The configuration is pretty easy.
Just provide the following settings as environment variables to your node process
or
This app uses dotenv, just create an .env file in the root folder and add the following variables to it.

Variable Description
WEB_PORT The port the app will use to run (ex. 3000)
SERVER_IP The game server ip and port (ex. 127.0.0.1:1234)
SERVER_KEY Some kind of secret key, should look something like this "fGL0Dayr"
DEFAULT_LANGUAGE Default language in 2 char iso format. Currently supported: en, de

You may find your servers IP and key in the Dedicated Server Administration under Settings ->Miscellaneous.
If you, for example, take a look at the Link XML, you will see the IP, Port and the "code" which is used in this project as SERVER_KEY.

Run Oasis on a server

I do not provide support for installation and hosting!

Docker

Creating Image

docker build . -t ls22-oasis

Running the image

docker run -it -e WEB_PORT=3000 -e SERVER_IP=your_server_ip:port -e SERVER_KEY=your_server_key -e DEFAULT_LANGUAGE=de -p 80:3000 ls22-oasis

Docker Compose example

services:
  ls22-oasis:
    image: bergi9/ls22-oasis:latest
    container_name: ls22-oasis
    restart: unless-stopped
    ports:
      - "80:3000"
    environment:
      WEB_PORT: 3000
      SERVER_IP: your_server_ip:port
      SERVER_KEY: your_server_key
      DEFAULT_LANGUAGE: de

Public Docker Image

bergi9/ls22-oasis

Authors

This project is licensed under GNU Lesser General Public License version 3 (GNU LGPLv3) - see the LICENSE file for details.

oasis's People

Contributors

msdigital avatar suppercraft5000 avatar bergi9 avatar

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.