Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 19 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,51 @@
# OpenFreezeCenter (OFC)
- Provides a UI and automated scripts in order to control MSI Laptops. Check the #Supported section to see what models are supported.
- Made for Linux, as MSI does not have a native Linux client.
- if you do now want to run the GUI or if it is not working for you then try
- if you don't want to run the GUI or if it is not working for you then try
# OpenFreezeCenter-Lite (OFC-l)
- Same thing just without GUI
- https://github.com/YoCodingMonster/OpenFreezeCenter-Lite

# INSTALLATION (Only first time)
- Creating virtual environment. the path i will be using is ```/home/pm/Desktop/OFC```. Here ```OFC``` is the folder with script.
# INSTALLATION
- apt-based distros
```
python3 -m pip install --user virtualenv
python3 -m venv /home/pm/Desktop/OFC
cd /home/pm/Desktop/OFC
sudo apt install libgirepository1.0-dev gcc libcairo2-dev pkg-config python3-dev gir1.2-gtk-4.0
```
- Install ```ECTweaker``` library, version 2.3 or above.
- dnf-based distros
```
bin/pip3 install ectweaker
sudo dnf install python3-gobject gobject-introspection gobject-introspection-devel gcc cairo-devel pkg-config python3-devel
```
- Install ``PyGObject``` library

- All distros
```
sudo apt install libgirepository1.0-dev gcc libcairo2-dev pkg-config python3-dev gir1.2-gtk-4.0
bin/pip3 install pycairo
bin/pip3 install PyGObject
python -m pip install pycairo PyGObject
```
- Make sure ```secure boot``` is disabled.
- Opening virtual environment. the path i will be using is ```/home/pm/Desktop/OFC```. Here ```OFC``` is the folder with script.
- Make sure secure boot is disabled.
```
cd /home/pm/Desktop/OFC
sudo nohup bin/python3 OFC.py
cd ~/Desktop/OFC
sudo nohup python OFC.py
```
- There are 2 outcomes.
- If the EC read/write is not enabled on your OS, the system will enable it and restart and follow up with the second point.
- If the EC read/write is enabled on your OS, the script will generate ```config.py``` file, which contains the configuration for fan curves and their addresses.
- DONE!
- If EC read/write is not enabled, the script will enable it and reboot.
- If EC read/write is enabled, the script will generate the ```config.py``` file, which contains the configuration for fan curves and their addresses.

# UPDATING
- Save your AUTO and ADVANCED speeds and in notepad and delete the old ```config.py``` file and then only try the new script.
- Opening virtual environment. the path i will be using is ```/home/pm/Desktop/OFC```. Here ```OFC``` is the folder with script.
- Save your AUTO and ADVANCED speeds, then delete ```config.py```.
```
cd /home/pm/Desktop/OFC
bin/pip3 install ectweaker -U
cd ~/Desktop/OFC
python -m pip ectweaker -U
sudo nohup bin/python3 OFC.py
```
- After you have run the script and new ```config.py``` file is created, paste the new values in the AUTO_SPEED and ADV_SPEED vales place.
- After you have run the script and the new ```config.py``` file is created, paste the new values in the AUTO_SPEED and ADV_SPEED vales place.

# RUNNING
- Opening virtual environment. the path i will be using is ```/home/pm/Desktop/OFC```. Here ```OFC``` is the folder with script.
```
cd /home/pm/Desktop/OFC
sudo nohup bin/python3 OFC.py
```
- Close the terminal and enjoy!!

## Supported Laptop models (tested)
- MSI GP76 11UG

## Supported Linux Distro (tested)
- Ubuntu

## Issue format
- ISSUE # [CPU] - [LAPTOP MODEL] - [LINUX DISTRO]
- ```Example``` ISSUE # i7-11800H - MSI GP76 11UG - UBUNTU 23.05
- ```Example``` ISSUE # i7-11800H - MSI GP76 11UG - UBUNTU 23.04

## Feedback
- Please provide suggestions under the Feedback discussion tab!
Expand Down