Skip to content

0xN0x/go-artifactsmmo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cover Image

⚔️ Artifacts SDK in Go [WIP]

Go Report Card codecov

go-artifactsmmo is a Go SDK for interacting with the ArtifactsMMO API, a unique MMORPG where the entire game is played by programming your own client or bot to control your character. Whether you're a coding newbie or a veteran at handling APIs, this project simplifies communication with the game.

🌍 What is ArtifactsMMO?

ArtifactsMMO is a MMORPG where you code your own bot or client to play. Picture an epic quest, but instead of pushing buttons, you're writing code! Manage your character, explore, fight, and interact with the game's universe—all through API calls.

🔧 Documentation

🚀 Installation

Add go-artifactsmmo to your project:

go get github.com/0xN0x/go-artifactsmmo

📖 Usage

Here's a quick example to get you started:

package main

import (
    "fmt"
    "github.com/0xN0x/go-artifactsmmo"
)

func main() {
    client := artifactsmmo.NewClient("your-api-token", "your-character-name")
    character, err := client.GetCharacterInfo()
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Printf("Welcome, %s (XP: %d/%d)!\n", character.Name, character.Xp, character.MaxXp)
}

⚙️ Features

  • API token authentication

📅 Todo

  • API token authentication
  • Continuous Integration
  • Movements
  • Fights management
  • Gathering ressources
  • Crafting
  • Tasks (quests) support
  • Inventory
    • Equipments
  • Bank
  • Recycling
  • Grand Exchange
  • Events
  • Safe rate limiting
  • Examples
  • Unit test (cov ~> 80%)

📚 Examples

🛠️ Work In Progress

This SDK is actively being developed! Expect frequent changes, but we're working hard to deliver a stable experience soon. 🚧

💻 Contributing

Contributions are more than welcome! If you have suggestions or patches, feel free to open a PR. Please try to follow Go best practices and aim for 80% or higher test coverage with your changes.

❤️ Contributors

⚖️ License

This project is licensed under the GPLv3 License.

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages