Giter VIP home page Giter VIP logo

xiv-sim-documentation's Introduction

Downloads

Simulator Download: Releases

Other Links: Discord | Twitter | Youtube | Documentation (Wiki)

  1. Download and extract the latest version from the releases page.
  2. If it is the first time you are running the simulator, you can click the "Redownload Mechanic Files From Github" button, which will automatically download the latest mechanic files files and place them in the correct place.
    • You can also download the mechanics folder manually from here as well, and put it in the root directory of the app.

Host Setup

  1. In order to host a room for multiplayer, you will need to enable port forwarding on your router. The steps for this will be different for each router.
  2. The following settings should be used for port forwarding:
    • Service Type: TCP/UDP
    • Internal Ports: 7777~7778
    • External Ports: 7777~7778
    • Server IPv4: (The local IP of the computer that you will be running the simulator on.)
  3. Once port forwarding is set up, you will be able to host by sharing your public IP.

โš Note about checking if port forwarding is working: Many online port forward checkers are not reliable and will report your port is closed even if it isn't. The best way to check is to have someone try to connect to you using the simulator. It should take a couple seconds for them to connect.


Scripting Setup (C#)

As of the 20210624-v2 release, you can now create the mechanic json files using C#. You can use any IDE/scripting environment that you would like.

In order to set up your project, you will need to reference the following 2 DLLs in your project, located in the XivMechanicSimNetworked_Data/Managed folder:

For development, I use Linqpad to write my scripts for generating the mechanic files. I have included all of the scripts that I have used to create the existing demos in this repo as a reference for how to create mechanics: xiv-sim-documentation/Linqpad

xiv-sim-documentation's People

Contributors

leonerdo5 avatar millhioref avatar ricimon avatar xiv-stats 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.