Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 4.07 KB

home.md

File metadata and controls

65 lines (50 loc) · 4.07 KB
title description published date tags editor dateCreated
The Official Artemis Wiki
The perfect place to learn more about Artemis and its usage
true
2023-10-03 13:23:47 UTC
markdown
2020-11-04 11:51:27 UTC

Introduction

Welcome to the Artemis 2.x wiki!
This is the perfect place to learn more about Artemis from a user perspective or as a (plugin) developer.

Right now Artemis 2 is in active development meaning some of the content on this wiki may go out of date and therefore be incorrect. In such a case, feel free to make changes or add new information.

Downloading Artemis

Build Status Every time a change is made to Artemis 2, a build is automatically created and uploaded.

Windows

The recommended way to install these builds is using the Artemis installer.

  • The installer will always install the latest build
  • You can use the installer to update Artemis
  • You don't need to download the installer to get a new version, just run it again

You may get a SmartScreen/virus warning but the installer is virus free and so is Artemis. This warning is because the installer is not digitally signed (doing so is very expensive). {.is-warning}

Linux

There is no graphical installer for Linux. The current recommended way to install Artemis on Linux is with the install script.

The script has been tested in a small amount of Linux installs, so feel free to review it before installing and contact the developers if you have issues or improvements to report.

You can download and execute the script in one go with the following command: curl -s -L https://builds.artemis-rgb.com/binaries/install-artemis-rgb.sh | bash

Alternatively, there are AUR and Flatpak packages available but they are not officially supported by the developers: Flatpak: https://github.com/ProjectSynchro/com.artemis_rgb.Artemis AUR: https://aur.archlinux.org/packages/artemisrgb-git (Currently broken)

Proper Artemis packages for Linux will be revisited once plugins can be downloaded directly from the workshop as this will make it easier to package.

Individual builds

If you don't want to use the installer, you can browse the builds per branch here.
The installer and the manual downloads both include all plugins from the Artemis.Plugins repository

Getting started

Check out our getting started guide which is a good place to learn more. That page contains links to all other guides (also found in the sidebar) and to walkthroughs.

It may also be useful to check out our FAQ.

Providing feedback

Any and all feedback is welcome, but before you do please take a look at the known issues page.
The preferred way to report bugs is via the GitHub issue tracker.
On GitHub you may also post questions and/or ideas but if you prefer you can also do so on our Discord server.

Development

While Artemis 2 is still in development, the plugin API is pretty far along.
To get started, take a look at our developer guides where we explain how Artemis works on a technical level and walk you through getting started on Artemis plugin development.

Contributing to the wiki

Any and all help is welcome :) To contribute, create an account here (the link is red but it works). PS: Please write your pages in Markdown, thank you!