aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 11:14:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Solution] Reformat and cleanup.

Browse Source
This commit is contained in:
Natalia Portillo
2023-10-03 22:19:46 +01:00
parent f32cdeecc6
commit 1252feea0c
5 changed files with 133 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.editorconfig
View File

@@ -1,13 +1,13 @@
[*] [*]
charset = utf-8 charset = utf-8
end_of_line = lf end_of_line = lf
indent_size = 4 indent_size = 2
indent_style = space indent_style = space
insert_final_newline = false insert_final_newline = false
max_line_length = 120 max_line_length = 120
tab_width = 4 tab_width = 2
trim_trailing_whitespace = false trim_trailing_whitespace = false
ij_continuation_indent_size = 8 ij_continuation_indent_size = 4
ij_formatter_off_tag = @formatter:off ij_formatter_off_tag = @formatter:off
ij_formatter_on_tag = @formatter:on ij_formatter_on_tag = @formatter:on
ij_formatter_tags_enabled = true ij_formatter_tags_enabled = true
@@ -668,6 +668,9 @@ ij_xml_space_around_equals_in_attribute = false
ij_xml_space_inside_empty_tag = false ij_xml_space_inside_empty_tag = false
ij_xml_text_wrap = normal ij_xml_text_wrap = normal
ij_xml_use_custom_settings = false ij_xml_use_custom_settings = false
indent_size = 2
tab_width = 2
ij_continuation_indent_size = 4
[{*.applescript,*.scpt}] [{*.applescript,*.scpt}]
indent_size = 2 indent_size = 2

7
.idea/.idea.Aaru/.idea/codeStyles/Project.xml generated
View File

@@ -202,5 +202,12 @@
<option name="WHILE_BRACE_FORCE" value="3" /> <option name="WHILE_BRACE_FORCE" value="3" />
<option name="FOR_BRACE_FORCE" value="1" /> <option name="FOR_BRACE_FORCE" value="1" />
</codeStyleSettings> </codeStyleSettings>
<codeStyleSettings language="XML">
<indentOptions>
<option name="INDENT_SIZE" value="2" />
<option name="CONTINUATION_INDENT_SIZE" value="4" />
<option name="TAB_SIZE" value="2" />
</indentOptions>
</codeStyleSettings>
</code_scheme> </code_scheme>
</component> </component>

63
GOVERNANCE.md
View File

@@ -4,60 +4,89 @@ This document defines the project governance for Aaru.
## Overview ## Overview
**Aaru**, an open source project, is committed to building an open, inclusive, and productive open source community focused on delivering a high quality tool that for backing up (dumping) various types of computer and game console media. **Aaru**, an open source project, is committed to building an open, inclusive, and productive open source community
focused on delivering a high quality tool that for backing up (dumping) various types of computer and game console
media.
The community is governed by this document with the goal of defining how community should work together to achieve this goal. The community is governed by this document with the goal of defining how community should work together to achieve this
goal.
## Code Repositories ## Code Repositories
The following code repositories are governed by Aaru community and maintained under the `aaru-dps` organization. The following code repositories are governed by Aaru community and maintained under the `aaru-dps` organization.
* **[010templates](https://github.com/aaru-dps/010templates):** Templates for [010editor](https://www.sweetscape.com/010editor). * **[010templates](https://github.com/aaru-dps/010templates):** Templates
for [010editor](https://www.sweetscape.com/010editor).
* **[Aaru.Checksums](https://github.com/aaru-dps/Aaru.Checksums):** Library that implements the hashing functionality. * **[Aaru.Checksums](https://github.com/aaru-dps/Aaru.Checksums):** Library that implements the hashing functionality.
* **[Aaru.CommonTypes](https://github.com/aaru-dps/Aaru.CommonTypes):** Common types needed by the different Aaru modules. * **[Aaru.CommonTypes](https://github.com/aaru-dps/Aaru.CommonTypes):** Common types needed by the different Aaru
modules.
* **[Aaru.Console](https://github.com/aaru-dps/Aaru.Console):** Text console handler. * **[Aaru.Console](https://github.com/aaru-dps/Aaru.Console):** Text console handler.
* **[Aaru.Decoders](https://github.com/aaru-dps/Aaru.Decoders):** Library for the decoding of structures from media and drives. * **[Aaru.Decoders](https://github.com/aaru-dps/Aaru.Decoders):** Library for the decoding of structures from media and
drives.
* **[Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption):** Library for the decryption of media. * **[Aaru.Decryption](https://github.com/aaru-dps/Aaru.Decryption):** Library for the decryption of media.
* **[Aaru.Documentation](https://github.com/aaru-dps/Aaru.Documentation):** Official documentation. * **[Aaru.Documentation](https://github.com/aaru-dps/Aaru.Documentation):** Official documentation.
* **[Aaru.Dreamcast](https://github.com/aaru-dps/Aaru.Dreamcast):** Tool for dumping GD-ROM using a real Dreamcast. * **[Aaru.Dreamcast](https://github.com/aaru-dps/Aaru.Dreamcast):** Tool for dumping GD-ROM using a real Dreamcast.
* **[Aaru.Dto](https://github.com/aaru-dps/Aaru.Dto):** DTOs for interchange between client and server portions of Aaru. * **[Aaru.Dto](https://github.com/aaru-dps/Aaru.Dto):** DTOs for interchange between client and server portions of Aaru.
* **[Aaru.Helpers](https://github.com/aaru-dps/Aaru.Helpers):** Helper functions. * **[Aaru.Helpers](https://github.com/aaru-dps/Aaru.Helpers):** Helper functions.
* **[Aaru](https://github.com/aaru-dps/aaru):** Main Aaru codebase. * **[Aaru](https://github.com/aaru-dps/aaru):** Main Aaru codebase.
* **[aaruremote](https://github.com/aaru-dps/aaruremote):** Small application allowing to send Aaru commands to a different computer. * **[aaruremote](https://github.com/aaru-dps/aaruremote):** Small application allowing to send Aaru commands to a
different computer.
* **[Aaru.Server](https://github.com/aaru-dps/Aaru.Server):** https://aaru.app server codebase. * **[Aaru.Server](https://github.com/aaru-dps/Aaru.Server):** https://aaru.app server codebase.
* **[Aaru.VideoNow](https://github.com/aaru-dps/Aaru.VideoNow):** VideoNow decoding and converting tool. * **[Aaru.VideoNow](https://github.com/aaru-dps/Aaru.VideoNow):** VideoNow decoding and converting tool.
* **[archaaru](https://github.com/aaru-dps/archaaru):** Scripts for the generation of Arch Linux Rescue CD including Aaru Data Preservation Suite. * **[archaaru](https://github.com/aaru-dps/archaaru):** Scripts for the generation of Arch Linux Rescue CD including
* **[fstester](https://github.com/aaru-dps/fstester):** Toolkit for the generation of test filesystems for later reverse engineer. Aaru Data Preservation Suite.
* **[fstester](https://github.com/aaru-dps/fstester):** Toolkit for the generation of test filesystems for later reverse
engineer.
* **[libaaruformat](https://github.com/aaru-dps/libaaruformat):** Main implementation of Aaru Media Image Format. * **[libaaruformat](https://github.com/aaru-dps/libaaruformat):** Main implementation of Aaru Media Image Format.
* **[RedBookPlayer](https://github.com/aaru-dps/RedBookPlayer):** Application to play Red Book audio from media dumps. * **[RedBookPlayer](https://github.com/aaru-dps/RedBookPlayer):** Application to play Red Book audio from media dumps.
## Community Roles ## Community Roles
* **Users:** Members that engage with the Aaru community via any medium (Discord, GitHub, etc.). * **Users:** Members that engage with the Aaru community via any medium (Discord, GitHub, etc.).
* **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation in proposal discussions, contributing code, etc.). * **Contributors:** Regular contributions to projects (documentation, code reviews, responding to issues, participation
* **Technical committee**: Provide input and feedback on roadmap items, grounded in common use cases for the committee member's organizations. Committee members might sponsor certain aspects of the project, however sponsorships are not a requirement for a committee member role. in proposal discussions, contributing code, etc.).
* **Maintainers**: The Aaru project leaders. They are responsible for the overall health and direction of the project; final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components within a project, acting as technical leads for that component. Maintainers are expected to contribute code and documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform maintenance tasks for these components. * **Technical committee**: Provide input and feedback on roadmap items, grounded in common use cases for the committee
member's organizations. Committee members might sponsor certain aspects of the project, however sponsorships are not a
requirement for a committee member role.
* **Maintainers**: The Aaru project leaders. They are responsible for the overall health and direction of the project;
final reviewers of PRs and responsible for releases. Some Maintainers are responsible for one or more components
within a project, acting as technical leads for that component. Maintainers are expected to contribute code and
documentation, review PRs including ensuring quality of code, triage issues, proactively fix bugs, and perform
maintenance tasks for these components.
### Maintainer nomination ### Maintainer nomination
New maintainers must be nominated by an existing maintainer and must be elected by a supermajority of existing maintainers. Likewise, maintainers can be removed by a supermajority of the existing maintainers or can resign by notifying one of the maintainers. New maintainers must be nominated by an existing maintainer and must be elected by a supermajority of existing
maintainers. Likewise, maintainers can be removed by a supermajority of the existing maintainers or can resign by
notifying one of the maintainers.
### Technical committee member nomination ### Technical committee member nomination
New technical committee members must be nominated by an existing member and must be elected by a supermajority of existing members. Likewise, members can be removed by a supermajority of the existing members or can resign by notifying one of the members. New technical committee members must be nominated by an existing member and must be elected by a supermajority of
existing members. Likewise, members can be removed by a supermajority of the existing members or can resign by notifying
one of the members.
### Supermajority ### Supermajority
A supermajority is defined as two-thirds of members in the group. A supermajority is defined as two-thirds of members in the group.
A supermajority of [Maintainers](MAINTAINERS.md) is required for certain decisions as outlined above. A supermajority vote is equivalent to the number of votes in favor being at least twice the number of votes against. For example, if you have 5 maintainers, a supermajority vote is 4 votes. Voting on decisions can happen on the mailing list, GitHub, Discord, email, or via a voting service, when appropriate. Maintainers can either vote "agree, yes, +1", "disagree, no, -1", or "abstain". A vote passes when supermajority is met. An abstain vote equals not voting at all. A supermajority of [Maintainers](MAINTAINERS.md) is required for certain decisions as outlined above. A supermajority
vote is equivalent to the number of votes in favor being at least twice the number of votes against. For example, if you
have 5 maintainers, a supermajority vote is 4 votes. Voting on decisions can happen on the mailing list, GitHub,
Discord, email, or via a voting service, when appropriate. Maintainers can either vote "agree, yes, +1", "disagree, no,
-1", or "abstain". A vote passes when supermajority is met. An abstain vote equals not voting at all.
### Decision Making ### Decision Making
We try to operate more on consensus than on votes, seeking agreement from the people who will have to do the work. We try to operate more on consensus than on votes, seeking agreement from the people who will have to do the work.
Natalia Portillo ([@claunia](https://github.com/claunia)) is the self-appointed benevolent dictator for life (SABDFL) for Aaru. Natalia Portillo ([@claunia](https://github.com/claunia)) is the self-appointed benevolent dictator for life (SABDFL)
for Aaru.
The community functions best when it can reach broad consensus about a way forward. However, it is not uncommon in the open-source world for there to be multiple good arguments, no clear consensus, and for open questions to divide communities rather than enrich them. The debate absorbs the energy that might otherwise have gone towards the creation of a solution. In many cases, there is no one ‘right’ answer, and what is needed is a decision more than a debate. The SABDFL acts to provide clear leadership on difficult issues, and set the pace for the project. The community functions best when it can reach broad consensus about a way forward. However, it is not uncommon in the
open-source world for there to be multiple good arguments, no clear consensus, and for open questions to divide
communities rather than enrich them. The debate absorbs the energy that might otherwise have gone towards the creation
of a solution. In many cases, there is no one ‘right’ answer, and what is needed is a decision more than a debate. The
SABDFL acts to provide clear leadership on difficult issues, and set the pace for the project.
## Lazy Consensus ## Lazy Consensus
@@ -67,7 +96,7 @@ and / or proposals should be shared by maintainers via
GitHub with the appropriate maintainers tagged. Out of respect for other contributors, GitHub with the appropriate maintainers tagged. Out of respect for other contributors,
major changes should also be accompanied by a notification on Discord or a note on the major changes should also be accompanied by a notification on Discord or a note on the
mailing list (not created yet) as appropriate. Author(s) of proposal, Pull Requests, mailing list (not created yet) as appropriate. Author(s) of proposal, Pull Requests,
issues, etc. will give a time period of no less than five (5) working days for issues, etc. will give a time period of no less than five (5) working days for
comment and remain cognizant of popular observed world holidays. comment and remain cognizant of popular observed world holidays.
Other maintainers may chime in and request additional time for review, but Other maintainers may chime in and request additional time for review, but

35
MAINTAINERS.md
View File

@@ -1,28 +1,29 @@
# Aaru Maintainers and Stakeholders # Aaru Maintainers and Stakeholders
[GOVERNANCE.md](https://github.com/aaru-dps/aaru/blob/main/GOVERNANCE.md) describes governance guidelines and maintainer responsibilities. [GOVERNANCE.md](https://github.com/aaru-dps/aaru/blob/main/GOVERNANCE.md) describes governance guidelines and maintainer
responsibilities.
## Maintainers ## Maintainers
| Maintainer | GitHub ID | Affiliation | | Maintainer | GitHub ID | Affiliation |
| --------------- | --------- | ----------- | |-------------------|---------------------------------------------|--------------------------|
| Natalia Portillo | [claunia](https://github.com/claunia) | [Aaru](https://aaru.app) | | Natalia Portillo | [claunia](https://github.com/claunia) | [Aaru](https://aaru.app) |
| Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) | | Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) |
| Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) | | Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) |
| Matt Nadareski | [mnadareski](https://github.com/mnadareski) | [Aaru](https://aaru.app) | | Matt Nadareski | [mnadareski](https://github.com/mnadareski) | [Aaru](https://aaru.app) |
## Technical committee ## Technical committee
| TC Member | GitHub ID | Affiliation | | TC Member | GitHub ID | Affiliation |
| --------------- | --------- | ----------- | |----------------|-----------------------------------------------------|---------------------------|
| Robin François| [robin-francois](https://github.com/robin-francois) | Cinémathèque suisse | | Robin François | [robin-francois](https://github.com/robin-francois) | Cinémathèque suisse |
| Joseph Redon | X | Game Preservation Society | | Joseph Redon | X | Game Preservation Society |
| Jonas Rosland | [jonasrosland](https://github.com/jonasrosland) | Hit Save! | | Jonas Rosland | [jonasrosland](https://github.com/jonasrosland) | Hit Save! |
## Aaru Contributors & Stakeholders ## Aaru Contributors & Stakeholders
| Feature | Contributor | GitHub ID | Affiliation | | Feature | Contributor | GitHub ID | Affiliation |
| --------------- | --------- | ----------- | --- | |-------------|-------------------|-------------------------------------------------|--------------------------|
| Development | Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) | | Development | Michael Drüing | [darkstar](https://github.com/darkstar) | [Aaru](https://aaru.app) |
| Development | Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) | | Development | Rebecca Wallander | [FakeShemp](https://github.com/FakeShemp) | [Aaru](https://aaru.app) |
| QA | Silas Laspada | [SilasLaspada](https://github.com/SilasLaspada) | [Aaru](https://aaru.app) | | QA | Silas Laspada | [SilasLaspada](https://github.com/SilasLaspada) | [Aaru](https://aaru.app) |

112
NEEDED.md
View File

@@ -73,67 +73,67 @@ This is a list of software whose physical media has some characteristics that ne
dumping of such characteristics. Usually those are copy protections. dumping of such characteristics. Usually those are copy protections.
- CD-i Ready - CD-i Ready
- Accelerator - Accelerator
- Alien Gate - Alien Gate
- Beyond Limits - Beyond Limits
- Escape - Escape
- Lucky Luke - Lucky Luke
- Louis Armstrong - Louis Armstrong
- Dark Fables of Aesop - Dark Fables of Aesop
- More Dark Fables of Aesop - More Dark Fables of Aesop
- Mozart - Mozart
- Opera Imaginaire - Opera Imaginaire
- Pavarotti - Pavarotti
- Steel Machine - Steel Machine
- The Apprentice - The Apprentice
- Dimo's Quest - Dimo's Quest
- The Worlds of... - The Worlds of...
- SafeDisc - SafeDisc
- Beowulf - Beowulf
- Black & White 2 - Black & White 2
- Brothers in Arms: Road to Hill 30 - Brothers in Arms: Road to Hill 30
- Carmageddon II: Carpocalypse Now - Carmageddon II: Carpocalypse Now
- Close Combat: Invasion Normandy - Close Combat: Invasion Normandy
- Codename: Eagle - Codename: Eagle
- SecuROM - SecuROM
- Arabian Nights - Arabian Nights
- Arcania: Gothic 4 - Arcania: Gothic 4
- Boiling Point: Road to Hell - Boiling Point: Road to Hell
- Cars 2 - Cars 2
- Colin McRae Rally 04 - Colin McRae Rally 04
- Colin McRae Rally 2.0 - Colin McRae Rally 2.0
- Colin McRae Rally 3 - Colin McRae Rally 3
- Command & Conquer: Red Alert 3 - Uprising - Command & Conquer: Red Alert 3 - Uprising
- Devil May Cry 4 - Devil May Cry 4
- Die Hard: Nakatomi Plaza - Die Hard: Nakatomi Plaza
- Disney Planes - Disney Planes
- StarForce - StarForce
- Black Mirror 3 - Black Mirror 3
- BloodRayne 2 - BloodRayne 2
- Chronostorm: Siberian Border - Chronostorm: Siberian Border
- Codename: Outbreak - Codename: Outbreak
- Dead to Rights - Dead to Rights
- Disciples III: Renaissance - Disciples III: Renaissance
- Mount & Blade - Mount & Blade
- Pac-Man World 2 - Pac-Man World 2
- Tages - Tages
- Anno 1701 - Anno 1701
- Darkstar One - Darkstar One
- Faery: Legends of Avalon - Faery: Legends of Avalon
- Helldorado - Helldorado
- Nostradamus: The Last Prophecy - Nostradamus: The Last Prophecy
- Silverfall - Silverfall
- Solidshield - Solidshield
- A-Train 8 - A-Train 8
- Anno 2070 - Anno 2070
- Assassin's Creed: Brotherhood - Assassin's Creed: Brotherhood
- Dead Mountaineer's Hotel - Dead Mountaineer's Hotel
- Dead Space 2 - Dead Space 2
- Helldorado - Helldorado
- I Am Alive - I Am Alive
- ObsCure II - ObsCure II
- Shift 2 Unleashed - Shift 2 Unleashed
- Warfare - Warfare
Information and test data Information and test data
========================= =========================