Giter Site home page Giter Site logo

alexislyndon / aeternum-map Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kattoor/aeternum-map

0.0 0.0 0.0 308.84 MB

https://aeternum-map.gg - Interactive map for New World

Home Page: https://www.overwolf.com/app/Leon_Machens-Aeternum_Map

License: MIT License

Shell 0.15% CSS 7.81% TypeScript 90.74% HTML 0.62% JavaScript 0.49% Dockerfile 0.19%

aeternum-map's Introduction

Aeternum Map - Interactive map for New World

Get all the locations, farming spots, resources, lore documents, chests, mobs and more!

Features

  • Live Tracking of your In-Game position
  • Check markers as done (like lore documents)
  • Automatic detection of your In-Game character
  • Auto start with New World
  • Private and guild markers (Coming Soon)
  • Areas (Coming Soon)
  • Near by (Coming Soon)
  • Dungeons (Coming Soon)

Contribution

This app is Open Source. Contributors are highly welcome!

Join us on our Discord.

Development

Please follow the instructions on Overwolf Developer to get white listed in Overwolf. Then you can start developing! In addition, you need access to a MongoDB.

Set environment variables

You can start by copying the template environment variables file.

cp template.env .env

The following list shows the variables you need to set:

KEY VALUE
PORT Port for the server environment
MONGODB_URI URI of your MongoDB server
VITE_API_ENDPOINT URL of your server environment
SCREENSHOTS_PATH Server side path to a folder in which screenshots will be saved
DISCORD_PUBLIC_WEBHOOK_URL Discord Webhook for public activity log
DISCORD_PRIVATE_WEBHOOK_URL Discord Webhook for private activity log
STEAM_API_KEY Steam API key required for oAuth
SESSION_SECRET Secret used to sign the session cookie
NO_SOCKET Run server without Socket for live position. Useful if you run multiple servers. Possible value: "true"
NO_API Run server without API and database. Useful if you run multiple servers. . Possible value: "true"
VITE_PLAUSIBLE_API_HOST Hostname of Plausible service
VITE_PLAUSIBLE_DOMAIN Name of the website on Plausible

Install dependencies

This project is based on Node.js. Make sure you have Node.js installed before installing the dependencies with:

npm install

You need to install Overwolf too.

Build project

You can build a production version of the server and client with:

npm run build

It is required to call this at least once before you can run this app in development mode.

Install as "unpacked extension"

Based on this guide you can install the app.

  • Open the Overwolf desktop client settings (by right-clicking the client and selecting "Packages" Or by clicking on the wrench icon in the dock and going to the "About" tab => "Development Options").

  • Click on "Development options".

  • In the opened window, click on "Load unpacked extension" and select the extracted '/dist/overwolf' folder. This will add the app to your Overwolf dock.

  • Make sure you are logged in to the OW client. Otherwise, you will get an "Unauthorized App" error message. (Click on the "Appstore" icon in the OW dock to login to the OW client).

Run development

npm run dev

This will run the server and client in development mode.

Start the app

Click on the app's icon in your OW dock to run the app. This will open the app if you run npm run dev before.

Licensing

MIT

aeternum-map's People

Contributors

lmachens avatar triadian avatar d4rktt avatar dillontherrien avatar razfriman avatar amartin916 avatar nimperx 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.