Anniversary Edition/Installer: Difference between revisions

From OniGalore
Jump to navigation Jump to search
No edit summary
m (link fix)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
AE Installer 2 (AEI2) is a Java app, for ease of bi-platform development; the old Installer (last at v1.1), was C-based but difficult to build. [[User:Admin|Alloc]] labeled his AEI "2.0" due to its new features and his having started the codebase over from scratch. In Windows, the Setup app that you download to get started will also install a local JRE (Java machine) in case you don't have Java installed. On the Mac it's a bit more complicated to bundle Java, so we've left it up to you to install Java yourself (but the Setup app contains a couple useful URLs to point you in the right direction). The app also requires .NET 2.0 in Windows and Mono on Macs. The AEI2 support thread is [http://oni.bungie.org/community/forum/viewtopic.php?id=2525 here].
AE Installer 2 (AEI2) is the program used to install mods, patches and tools, as part of the [[Anniversary Edition]]. The app requires Java, as well as .NET 2.0 or higher in Windows and Mono in macOS. The AEI2 has a support thread on the forum [http://oni.bungie.org/forum/viewtopic.php?id=2525 here]. The source code is available [https://websvn.illy.bz/listing.php?repname=Oni2&path=%2Fjava%2F here].


The AEI talks to the {{OMD}} and gets a list of available mods (it actually reads a cache which is updated every two minutes, so if you're expecting to see your Depot change take effect immediately, you might be confused). It then offers those for download and installation. It will also detect when an installed mod has an update available, and can even update itself using the supporting Java program AEInstaller2Updater.  
The AEI talks to the {{OMD}} and gets a list of available mods (the list is updated every two minutes). It then offers those for download and installation. It will also detect when an installed mod has an update available, and can even update itself using the supporting program [[/Updater|AEInstaller2Updater]]. The AEI also supports localization (easy translation into other languages). Currently the AEI can run in English, German, and Russian; if you want to contribute a new localization, read [[/Localization|this page]]. You can email Alloc with your strings when you're done.


https://lh4.googleusercontent.com/-dvydYaJVWyE/UWm5iwproAI/AAAAAAAAD-E/Gz32rSUdezU/s800/AEI%25202.06.jpg
:''Subpages:'' [[/Change_log|Installer change log]], [[/Localization|Localization]], [[/Updater|Updater]]


==GUI scaling==
On modern displays you may want to change the DPI settings of the program, otherwise text, tables and controls will appear too small.


The AEI itself should overall be self-explanatory, but here's some power-user tips:
'''Windows:'''
: Right-click the shortcut "AEInstaller2".
: Properties > Compatibility > Change high DPI settings
:: [x] Override high DPI scaling behavior:
:: System (Enhanced)


==Main window==
[[Image:AEI main window.jpg|center]]


*Status column - Each mod starts off with "___", three blank spots. The first will become 'I' when the mod is "installed", the middle space will become 'U' if an "update" is available, and the last becomes 'D' when you've "downloaded" the mod.
*Status column - Each mod starts off with "___", three blank spots. The first will become 'I' when the mod is "installed", the middle space will become 'U' if an "update" is available, and the last becomes 'D' when you've "downloaded" the mod.
Line 18: Line 26:


*You can hide/show columns by right-clicking the column header:
*You can hide/show columns by right-clicking the column header:
https://lh3.googleusercontent.com/-0FuR9Rmcp9g/UWm5SAoxQ8I/AAAAAAAAD90/KV5UEKClkS8/s800/AEIcolumn%2520select.jpg
[[Image:AEI column menu.jpg|center]]




*You can right-click a mod to go to the mod's page on the Depot, go to the package on your HD (if downloaded), delete the mod locally (if downloaded), or force a re-download; this might be useful if you messed up or deleted the content of the mod on your hard drive, or if you think you got a corrupted download.
*You can right-click a mod to go to the mod's page on the Depot, go to the package on your HD (if downloaded), delete the mod locally (if downloaded), or force a re-download; this might be useful if you messed up or deleted the content of the mod on your hard drive, or if you think you got a corrupted download.
https://lh6.googleusercontent.com/-c8ucA5-KVC4/UWm5cXC3bMI/AAAAAAAAD98/OjTXf-X_LAU/s800/AEI%2520context%2520menu.jpg
[[Image:AEI mod context menu.jpg|center]]
 


==Mods menu==
*You can save a list of your current selection of mods by choosing '''Mods>Save current mod selection''', then restore the list later using '''Mods>Load mod selection''' (this only saves the list of selected mods, not the actual mods).
*You can save a list of your current selection of mods by choosing '''Mods>Save current mod selection''', then restore the list later using '''Mods>Load mod selection''' (this only saves the list of selected mods, not the actual mods).


*Also, don't forget to check out the AEI's Preferences. Notice that the AEI copies over [[outro]] by default, but not [[intro]]. It's recommended that you keep the update notification option checked.
==Settings==
https://lh5.googleusercontent.com/-XWxbDd7t-zY/UWm5FeK6iSI/AAAAAAAAD9c/ZiJ5xlOuTEE/s800/AEI%2520settings.jpg
*Also, don't forget to check out the AEI's Settings. Notice that the AEI copies over [[outro]] by default, but not [[intro]]. It's recommended that you keep the update notification option checked.
 
[[Image:AEI settings.jpg|center]]
 
*You can view core packages by choosing '''Mods>Show core packages''', you can view the description of these packages, and right click to open their mod folder, or to re-downlaod them if necessary, but you can't delete them. These packages will always be auto-updated.
https://lh5.googleusercontent.com/-4rBuiG4EW2A/UWm5MatiCgI/AAAAAAAAD9s/zKdsUIrZuLM/s800/AEI%2520core%2520packs.jpg
 
 
*You can manage modding tools by choosing '''Tools>Manage Tools''', from there you can download and install or uninstall tools. Installed tools will later appear under the '''Tools''' menu for easy access.
https://lh4.googleusercontent.com/-ZKZ1vYp-w2Q/UWm5IHG2fPI/AAAAAAAAD9k/M4ZM34PaSJA/s800/AEI%2520tool%2520manager.jpg


==Core packages==
*You can view core packages by choosing '''Mods>Show core packages'''. You can view the description of these packages, and right-click to open their mod folder, or to re-download them if necessary, but you can't delete them. These packages will always be automatically installed and updated.
[[Image:AEI core window.jpg|center]]


*The AEI also supports localization (easy translation into other languages). Currently the AEI only supports English and German, but if you want to contribute a translation, read [[/Localization|this page]].  You can email Alloc with your strings when you're done.
==Tools==
*You can manage modding tools by choosing '''Tools>Manage Tools'''. From there you can download and install or uninstall tools. Installed tools will later appear under the '''Tools''' menu for easy access.
[[Image:AEI tool window.jpg|center]]


[[Category:Anniversary Edition]]
[[Category:Anniversary Edition]]

Latest revision as of 17:28, 3 December 2023

AE Installer 2 (AEI2) is the program used to install mods, patches and tools, as part of the Anniversary Edition. The app requires Java, as well as .NET 2.0 or higher in Windows and Mono in macOS. The AEI2 has a support thread on the forum here. The source code is available here.

The AEI talks to the Oni Mod Depot and gets a list of available mods (the list is updated every two minutes). It then offers those for download and installation. It will also detect when an installed mod has an update available, and can even update itself using the supporting program AEInstaller2Updater. The AEI also supports localization (easy translation into other languages). Currently the AEI can run in English, German, and Russian; if you want to contribute a new localization, read this page. You can email Alloc with your strings when you're done.

Subpages: Installer change log, Localization, Updater

GUI scaling

On modern displays you may want to change the DPI settings of the program, otherwise text, tables and controls will appear too small.

Windows:

Right-click the shortcut "AEInstaller2".
Properties > Compatibility > Change high DPI settings
[x] Override high DPI scaling behavior:
System (Enhanced)

Main window

AEI main window.jpg
  • Status column - Each mod starts off with "___", three blank spots. The first will become 'I' when the mod is "installed", the middle space will become 'U' if an "update" is available, and the last becomes 'D' when you've "downloaded" the mod.
  • As long as the mod list is the active window pane, you can press any letter to jump to the mod that begins with that letter; press it again to cycle through the remaining mods that start with that letter.
  • You can sort the mods by clicking on the column headers; sort by the "Last change" or "Added" columns to see what's new on the Depot.
  • The AEI will remember the sort order you choose, what columns you choose to display, and the window size you set it to have.
  • You can hide/show columns by right-clicking the column header:
AEI column menu.jpg


  • You can right-click a mod to go to the mod's page on the Depot, go to the package on your HD (if downloaded), delete the mod locally (if downloaded), or force a re-download; this might be useful if you messed up or deleted the content of the mod on your hard drive, or if you think you got a corrupted download.
AEI mod context menu.jpg

Mods menu

  • You can save a list of your current selection of mods by choosing Mods>Save current mod selection, then restore the list later using Mods>Load mod selection (this only saves the list of selected mods, not the actual mods).

Settings

  • Also, don't forget to check out the AEI's Settings. Notice that the AEI copies over outro by default, but not intro. It's recommended that you keep the update notification option checked.
AEI settings.jpg

Core packages

  • You can view core packages by choosing Mods>Show core packages. You can view the description of these packages, and right-click to open their mod folder, or to re-download them if necessary, but you can't delete them. These packages will always be automatically installed and updated.
AEI core window.jpg

Tools

  • You can manage modding tools by choosing Tools>Manage Tools. From there you can download and install or uninstall tools. Installed tools will later appear under the Tools menu for easy access.
AEI tool window.jpg