Documentation

Documentation & Manual

The purpose of this page is to give you all information about MAGNETAR.

🔘 | Initialization

MAGNETAR requires root privileges to operate. Before entering any MAGNETAR CLI commands, the user must first grant root permission to the terminal emulator using the su command. Example commands that are executed under # prefix are executed with root permission.

Example Usages:

$ su
# magnetar --help

$ su -c magnetar --manual

🧠 | AI

MAGNETAR employs a machine learning algorithm to improve overall user experience by adapting how things are set and/or controlled based on how user interact with the device.

• train

  Begin force training of the algorithm; this command may take some time to execute depending on how much data is already on the device.

• reset

  Reset machine learning data; this command will erase learn rates and may result in incorrect adaptation based on user usage after resetting. Keep in mind that the longer a user uses MAGNETAR, the better it will become at adapting.

Example Usages:

# magnetar --ai train
# magnetar --ai reset

⚙️ | Android Runtime

ART performs better than JIT (just-in-time) compilation into bytecode because it uses AOT (ahead-of-time) compilation into native code. ART can be configured to perform this optimization in a variety of ways.

• disable

  Disables MAGNETAR+'s automatic ART optimization; changing the profile will re-enable it.

• optimize

  Run the background dexopt job; this command will optimize the background dexopt job, which may take some time to complete.

• profile

  Recompile native app code to specific profiles; this command requires MAGNETAR+ to function. This allows the user to select optimization profiles such as the ones listed below:

  • balance
  • everything
  • everything-profile
  • size
  • size-profile
  • space
  • space-profile
  • speed
  • speed-profile

Exanple Usages:

# magnetar --art optimize
# magnetar --art profile speed-profile

📀 | Backup

MAGNETAR allows the user to save a backup of all configuration settings.

• export

  Back up user configuration in the MAGNETAR folder on the internal storage.

• import

  Select and restore backup; all of the previous data will be restored.

Example Usages:

# magnetar --backup import
# magnetar --backup export

🐞 | Bugreport

MAGNETAR allows users to send a bugreport directly from its CLI; however, user must have an active internet connection to send the file to the bugreport channel.

Example Usage:

# magnetar --bugreport

🗃️ | Database

MAGNETAR allows users to manage and view saved data for per-app profiles such as renderer, refresh rate, kcal, and others...

• custom

  View the custom profiles created.

• static

  Find out which games MAGNETAR might be able to detect automatically on the device.

• refresh

  Updates the static database app list; use this command to allow MAGNETAR to detect a newly installed app.

• reset

  Delete all or specific databases, such as the ones listed below:

  • mode
  • kcal
  • preload
  • ram
  • refresh-rate
  • renderer
  • thermal
  • threshold

Example Usages:

# magnetar --database custom
# magnetar --database static
# magnetar --database reset renderer

💤 | Doze

In doze mode, the system tries to save battery life by limiting app access to network and CPU-intensive services. It also prevents apps from connecting to the network and postpones their jobs, syncs, and standard alarms. With MAGNETAR, users can select a preset profile to help them restrict apps with varying intensities, as shown below:

• default

  Device default doze profile.

• light

  A light doze profile that has no effect on normal usage.

• moderate

  In exchange for a little more saving, notification can be slightly delayed.

• aggressive

  System checks and processes will be delayed to allow for deeper device sleep.

• extreme

  Prioritizes power savings with a significant impact on background tasks.

Example Usage:

# magnetar --doze aggressive

⚡ | Fast Charge

MAGNETAR allows compatible kernels to enable or disable the force fast charging feature; enabling this feature may cause the device to overheat due to the faster charging speed.

• enable

  Enable the fast charging feature.

• disable

  Disable the fast charging feature.

Example Usage:

# magnetar --fastcharge disable

🎮 | Game Utility

MAGNETAR enables a game dashboard-like experience for a more immersive gaming experience.

• enable

  Enable DND and disable automatic brightness while playing games.

• disable

  Turn off this feature completely.

Example Usage:

# magnetar --game enable

🎨 | KCAL

MAGNETAR allows users to select different color profiles for the device's screen as well as set per-app color profiles; however, setting per-app color profiles requires MAGNETAR+.

• default

  Make use of the device's standard color profile.

• coffee

  Coffee-colored color profile.

• cozy

  A nice looking warm color profile.

• lucid

  Improved color profile for a more appealing appearance.

• nostalgia

  A saturated color profile from an early version of MAGNETAR.

• obsidian

  Deep color profile with a slight saturation boost.

Example Usage:

# magnetar --kcal obsidian

✏️ | Profiling

Adding:

# magnetar --kcal set <profile> <com.package.name>

Removing:

# magnetar --kcal unset <com.package.name>

🔑 | Key

MAGNETAR allows the user to generate a secure key that will be used to register for MAGNETAR+ and/or check the status of the registration.

• generate

  Generates the MAGNETAR+ registration key.

• verify

  Check the status of user verification, whether it is a basic or MAGNETAR+ user.

Example Usages:

# magnetar --key generate
# magnetar --key verify

📋 | Log

MAGNETAR allows users to view and/or export logs as needed.

• activity

  Displays user activity logs.

• debug

  Display the debug log, which is displayed whenever MAGNETAR encounters an error while setting something on the user device.

• export

  Save logs to the MAGENTAR folder on internal storage.

Example Usages:

# magnetar --log debug
# magnetar --log export

📳 | Modes

MAGNETAR enables user to run and/or configure modes per application. Cooldown and sleep modes, for example, cannot be overridden.

• adaptive (Recommended)

  This mode employs MAGNETAR's machine learning and includes all available modes; it will dynamically adjust device tuning as the ML predicts the best mode for the scenario.

• endurance+

  This mode reduces CPU frequencies by 35% and GPU frequencies by 50%, favoring battery life over performance and giving user an extra screen on time. This option is not available through the CLI, but it can be enabled by enabling system battery saver or automatically by the powersave option.

• endurance

  This mode reduces CPU and GPU frequencies by about 25% and 40%, respectively, allowing user to gain an extra screen on time at the expense of performance.

• balance

  This mode reduces CPU frequencies by about 15% and GPU frequencies by 20%, giving user just enough performance while saving battery life.

• balance+

  This mode will still reduce frequencies by 5% while increasing GPU frequencies by about 40%, enough to handle heavy tasks but not all the way through.

• extreme

  In this mode, the CPU frequency limiter is removed, and the GPU frequency is increased by 60% to maintain good quality performance suitable for heavy tasks and/or games at the expense of battery life.

• game

  In this mode, the CPU frequency limitation is disabled, input boost frequencies are set to maximum, and the GPU frequency is also set to maximum to maintain excellent gaming performance at the expense of battery life. This option is not available via CLI, but it will be activated automatically in adaptive mode when playing games for basic users. Only MAGNETAR+ users have the ability to lock and/or configure per-app game mode.

• cooldown

  This mode gradually reduces performance; the longer it is active, the lower the performance the user will receive to prevent the device from overheating. This action can be sped up or slowed down by lowering or raising the threshold value and/or charging the device.

• sleep

  This mode will be activated after the device has been put to sleep, and it will perform other maintenance tasks before pausing MAGNETAR's processes, which will resume once the device is turned back on.

Example Usage:

# magnetar --mode balance+

✏️ | Profiling

Adding:

# magnetar --mode set <profile> <com.package.name>

Removing:

# magnetar --mode unset <com.package.name>

📌 | Notification

The user has the option to disable or enable the MAGNETAR notification service.

• enable

  Turn on notification service.

• disable

  Turn of notification service.

Example Usage:

# magnetar --notification disable

🔋 | Powersave

With MAGNETAR, user can set an automatic power saver between 0 and 50 percent battery capacity.

• 0-50

  A value between 1 and 50 tells MAGNETAR when to enable endurance+ mode and overrides other modes. If set to 0, this functionality is disabled.

Example Usage:

# magnetar --powersave 25

⌛ | Preload

With MAGNETAR, the user can preload applications in physical RAM, which speeds up read speeds. This feature requires MAGNETAR+ to function.

• load

  Loads the application into the RAM.

• unload

  Unload the preloaded application from RAM.

Example Usage:

# magnetar --preload unload <com.package.name>

🗄️ | RAM

MAGNETAR gives the user the ability to manage RAM in a variety of ways. This can also be configured per application, but only if the user is registered with MAGNETAR+.

• dynamic

  Improves overall RAM management based on how much RAM is currently in use.

• balance

  Balanced memory management based on actual device RAM.

• light

  Non-aggressive memory management that is suitable for multitasking.

• moderate

  Balance-like but with more aggressive memory management.

• aggressive

  Aggressive memory management that closes background tasks more frequently.

Example Usage:

# magnetar --ram dynamic

✏️ | Profiling

Adding:

# magnetar --ram set <profile> <com.package.name>

Removing:

# magnetar --ram unset <com.package.name>

📱 | Refresh-rate

MAGNETAR allows the user to customize the refresh rate for each application. This does not apply to devices that do not support multiple screen refresh rates. This option can also be synchronized, enabled, and disabled.

• enable

  Enables the refresh-rate manager.

• disable

  Disables the refresh-rate manager.

• sync

  Synchronize with the current refresh-rate of the device.

• integer (According to device refresh-rates)

  Sets an application's refresh rate. This option may also be available for dynamic refresh-rate.

Example Usage:

# magnetar --refresh-rate sync

✏️ | Profiling

Adding:

# magnetar --refresh-rate set <profile> <com.package.name>

Removing:

# magnetar --refresh-rate unset <com.package.name>

🖼️ | Renderer

MAGNETAR allows the user to configure the renderer, even per application. It can also be turned off.

• opengl

  This renderer is primarily set as the default for Android, providing balanced performance between 2D and 3D rendering.

• skiagl

  This renderer performs better in 2D but not in 3D screen element rendering.

• vulkan

  This renderer will perform better at 3D rendering, giving user an advantage in the 3D space that is commonly used in games, but 2D rendering will be inferior to SkiaGL and OpenGL.

• disable

  Disable renderer manager; setting another renderer activates renderer manager again.

Example Usage:

# magnetar --renderer skiagl

✏️ | Profiling

Adding:

# magnetar --renderer set <profile> <com.package.name>

Removing:

# magnetar --renderer unset <com.package.name>

📲 | Resolution

MAGNETAR allows the user to reduce the device's resolution, freeing up GPU resources for improved rendering performance at the expense of graphics quality. Be aware of the setting resolution and confirm that the phone is operational before locking it. This option can also be set per application for Android 12 or newer devices registered with MAGNETAR+.

• 50-90

  Select a percentage for device resolution; 100% will set the device's native screen resolution.

• disable

  Disable resolution manager; setting resolution will re-enable it.

• sync

  Synchronize the DPI to allow MAGNETAR to rescale the resolution as it appears on the screen.

• fix

  Resolves UI and in-app elements that break after changing resolution.

Example Usage:

# magnetar --resolution 69

✏️ | Profiling

Adding:

# magnetar --resolution set <profile> <com.package.name>

Removing:

# magnetar --resolution unset <com.package.name>

🔥 | Thermal

With MAGNETAR, the user can disable or enable system thermals. Disabling may improve performance, but it may cause the phone to heat up faster and degrade battery life more quickly over time. Furthermore, for safety reasons, disabling thermals does not disable MAGNETAR cooldown mode. This option is also available per application, but it is only available to MAGNETAR+ users.

• enable

  Turns on system thermals and, if applicable, custom thermals.

• disable

  Disable and override thermals.

Example Usage:

# magnetar --thermal enable

✏️ | Profiling

Adding:

# magnetar --thermal set <profile> <com.package.name>

Removing:

# magnetar --thermal unset <com.package.name>

🌡️ | Threshold

With MAGNETAR, the user can change the threshold to delay or advance cooldown mode activation. This only allows for a temperature range of 40-50 degrees Celsius, and the base threshold is subtracted by 3 when charging. This option is also available per application, but it is only available to MAGNETAR+ users.

• 40-50

  The threshold value at which MAGNETAR's cooldown mode feature is activated. Setting threshold value to 49 or 50 would require MAGNETAR+.

Example Usage:

# magnetar --threshold 45

✏️ | Profiling

Adding:

# magnetar --threshold set <profile> <com.package.name>

Removing:

# magnetar --threshold unset <com.package.name>

🔄 | Update

MAGNETAR allows users to install/check updates and switch between stable, beta, and canary update channels. However, only MAGNETAR+ users can install the update from the CLI and/or switch to the canary channel.

• check

  To get the latest MAGNETAR updates.

• stable

  Switch updates channel to stable.

• beta

  Switch updates channel to beta.

• canary

  Switch updates channel to canary. Switching to canary channel requires MAGNETAR+.

Example Usage:

# magnetar --update check

👤 | User

MAGNETAR allows users to check and manage user configurations.

• view

  Show the MAGNETAR configuration.

• reset

  Clear all MAGNETAR configuration.

Example Usage:

# magnetar --user view

🆘 | CLI

Can't seem to find what you're looking for or getting an error message? Some of the commands in the wiki may not be available for all MAGNETAR versions, but it is equipped with a manual to guide users based on the version they have.

Check Out: magnetar --manual