No description
Find a file
2024-08-06 17:06:14 +01:00
.openapi-generator Update to API version 1.5 2024-08-06 17:06:14 +01:00
config Initial commit 2024-08-02 19:18:17 +01:00
lib Update to API version 1.5 2024-08-06 17:06:14 +01:00
test Initial commit 2024-08-02 19:18:17 +01:00
.formatter.exs Initial commit 2024-08-02 19:18:17 +01:00
.gitignore Initial commit 2024-08-02 19:18:17 +01:00
.openapi-generator-ignore Update to API version 1.5 2024-08-06 17:06:14 +01:00
mix.exs Update to API version 1.5 2024-08-06 17:06:14 +01:00
mix.lock Initial commit 2024-08-02 19:18:17 +01:00
README.md Update to API version 1.5 2024-08-06 17:06:14 +01:00

ArtifactsAPI

Artifacts is an API-based MMO game where you can manage 5 characters to explore, fight, gather resources, craft items and much more. Website: https://artifactsmmo.com/ Documentation: https://docs.artifactsmmo.com/ OpenAPI Spec: https://api.artifactsmmo.com/openapi.json

Building

To install the required dependencies and to build the elixir project, run:

mix local.hex --force
mix do deps.get, compile

Installation

If available in Hex, the package can be installed by adding artifacts_api to your list of dependencies in mix.exs:

def deps do
  [{:artifacts_api, "~> 0.1.5"}]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/artifacts_api.

Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).

config :artifacts_api, base_url: "http://localhost"

Multiple clients for the same API with different URLs can be created passing different base_urls when calling ArtifactsAPI.Connection.new/1:

client = ArtifactsAPI.Connection.new(base_url: "http://localhost")