astra/README.md

# Astra

A FFXIV launcher for Linux that supports profiles, multiple accounts and [Dalamud](https://github.com/goatcorp/Dalamud) plugins!

### Notice

Astra is _beta software_. Despite this, the launcher is feature complete, but you may find it lacking for the use-cases
below:

* [Logging into Steam-linked accounts is unsupported.](https://todo.sr.ht/~redstrate/astra/1)

![Main Screenshot](misc/screenshot.png)

If you still have questions, please read the [FAQ](https://xiv.zone/astra/faq) first.

## Features

* Handles running Wine for you, creating a seamless and native-feeling launcher experience!
    * Can also easily enable several Linux-specific enhancements such as Fsync or configuring Gamescope.
* Multiple account support!
    * Can associate a Lodestone character with an account to use as an avatar.
* Easily install and use Dalamud plugins.
* Game patching support.
* Securely login to the official Square Enix lobbies, as well as Sapphire servers.
    * Game arguments are encrypted by default, providing the same level of security as other launchers.
    * Saving account usernames and passwords are also supported, and is never stored plaintext.
* Can install FFXIV on new systems for you, bypassing the normal InstallShield installer.

## Get It

Details on where to find stable releases of Astra can be found on its [homepage](https://xiv.zone/astra).

Distribution packaging is encouraged, so please send an [email through the mailing list](https://lists.sr.ht/~redstrate/public-inbox) for any concerns.

## Support

If you have an issue with Astra, please [send an email to the mailing list](https://lists.sr.ht/~redstrate/public-inbox).

## Building

Please refer to the [building document](BUILDING.md) for instructions on how to build Astra.

## Contributing

Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Novus.

## License

![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)

This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata.
Rename to Astra 2022-02-23 19:00:17 -05:00			`# Astra`
Add initial files 2021-11-01 09:54:58 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`A FFXIV launcher for Linux that supports profiles, multiple accounts and [Dalamud](https://github.com/goatcorp/Dalamud) plugins!`
Update README to include shrt repository 2022-02-28 21:07:13 -05:00
Improve README 2022-08-15 13:19:23 -04:00			`### Notice`
Remove mirror links 2022-06-23 14:23:12 -04:00
Improve README 2022-08-15 13:19:23 -04:00			`Astra is _beta software_. Despite this, the launcher is feature complete, but you may find it lacking for the use-cases`
			`below:`
Remove mirror links 2022-06-23 14:23:12 -04:00
Improve README 2022-08-15 13:19:23 -04:00			`* [Logging into Steam-linked accounts is unsupported.](https://todo.sr.ht/~redstrate/astra/1)`
Add initial files 2021-11-01 09:54:58 -04:00
Rewrite README in anticipation for future Steam Deck support 2022-06-08 15:20:21 -04:00			`![Main Screenshot](misc/screenshot.png)`
Update README 2021-11-10 05:37:45 -05:00
Improve README 2022-08-15 13:19:23 -04:00			`If you still have questions, please read the [FAQ](https://xiv.zone/astra/faq) first.`

Add initial files 2021-11-01 09:54:58 -04:00			`## Features`
Improve README 2022-08-15 13:19:23 -04:00
Complete rewrite to Kirigami Giant commit overhauling the interface to use KDE's Kirigami framework, which is based on Qt Quick. The logic is all but rewritten, allowing accounts to be separate from profiles. 2023-07-30 08:49:34 -04:00			`* Handles running Wine for you, creating a seamless and native-feeling launcher experience!`
Improve README 2022-08-15 13:19:23 -04:00			`* Can also easily enable several Linux-specific enhancements such as Fsync or configuring Gamescope.`
			`* Multiple account support!`
Complete rewrite to Kirigami Giant commit overhauling the interface to use KDE's Kirigami framework, which is based on Qt Quick. The logic is all but rewritten, allowing accounts to be separate from profiles. 2023-07-30 08:49:34 -04:00			`* Can associate a Lodestone character with an account to use as an avatar.`
			`* Easily install and use Dalamud plugins.`
			`* Game patching support.`
Rewrite README in anticipation for future Steam Deck support 2022-06-08 15:20:21 -04:00			`* Securely login to the official Square Enix lobbies, as well as Sapphire servers.`
Improve README 2022-08-15 13:19:23 -04:00			`* Game arguments are encrypted by default, providing the same level of security as other launchers.`
			`* Saving account usernames and passwords are also supported, and is never stored plaintext.`
Complete rewrite to Kirigami Giant commit overhauling the interface to use KDE's Kirigami framework, which is based on Qt Quick. The logic is all but rewritten, allowing accounts to be separate from profiles. 2023-07-30 08:49:34 -04:00			`* Can install FFXIV on new systems for you, bypassing the normal InstallShield installer.`
Update README with AUR links 2022-03-16 09:48:45 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`## Get It`
Rewrite README in anticipation for future Steam Deck support 2022-06-08 15:20:21 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`Details on where to find stable releases of Astra can be found on its [homepage](https://xiv.zone/astra).`
Improve README 2022-08-15 13:19:23 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`Distribution packaging is encouraged, so please send an [email through the mailing list](https://lists.sr.ht/~redstrate/public-inbox) for any concerns.`
Rewrite README in anticipation for future Steam Deck support 2022-06-08 15:20:21 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`## Support`
Improve README 2022-08-15 13:19:23 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`If you have an issue with Astra, please [send an email to the mailing list](https://lists.sr.ht/~redstrate/public-inbox).`
Update README 2021-11-10 05:37:45 -05:00
Redo screenshot and README in preparation for 0.4.0 release 2022-04-17 21:48:31 -04:00			`## Building`
Improve README 2022-08-15 13:19:23 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`Please refer to the [building document](BUILDING.md) for instructions on how to build Astra.`
Update README 2022-06-01 12:18:38 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`## Contributing`
Update links in README This also adds a brand new contributing section! 2022-03-01 09:27:52 -05:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`Please refer to the [contributing document](CONTRIBUTING.md) for everything you need to know to get started contributing to Novus.`
Remove mirror links 2022-06-23 14:23:12 -04:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`## License`
Update links in README This also adds a brand new contributing section! 2022-03-01 09:27:52 -05:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)`
Update links in README This also adds a brand new contributing section! 2022-03-01 09:27:52 -05:00
Improve README, add CONTRIBUTING and BUILDING 2023-08-18 12:17:12 -04:00			`This project is licensed under the [GNU General Public License 3](LICENSE). Some code or assets may be licensed differently, please refer to the [REUSE](https://reuse.software/spec/) metadata.`