Skip to content

Commit

Permalink
Cleanup: Remove MSBuild / SLN
Browse files Browse the repository at this point in the history
Resolve #89

Update README and gitignore
  • Loading branch information
dreamsyntax committed Jan 21, 2025
1 parent b6e7f79 commit ec16678
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 216 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Source/[Bb]uild*/
Source/[Bb]inary/
Source/bin/
Source/CMakeSettings.json
Source/obj/
Source/GeneratedFiles/
Source/cmake-build-debug/*
Source/out/
Source/*.ipch
Source/*.opensdf
Source/*.sdf
Expand All @@ -17,4 +19,6 @@ Source/.vs/
Source/.vscode/
.vscode/
.idea/*
.DS_Store
.DS_Store
.vs/
.vscode/
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The GUI is aimed for convenience, without disrupting the performance of the emul
For binary releases of this program, refer to [the "releases" page](https://github.com/aldelaro5/dolphin-memory-engine/releases) on [the Github repository](https://github.com/aldelaro5/dolphin-memory-engine).

## Build Status

### Linux:
[![Build](https://github.com/aldelaro5/dolphin-memory-engine/actions/workflows/build.yml/badge.svg)](https://github.com/aldelaro5/dolphin-memory-engine/actions/workflows/build.yml)

Expand All @@ -22,6 +23,8 @@ For binary releases of this program, refer to [the "releases" page](https://gith
## System requirements
Any x86_64 based system should work.

This repository uses CMake for all platforms.

At least 250 MB of free memory is required.

You need to have Dolphin running ***and*** _have the emulation started_ for this program to be useful. As such, the system must meet Dolphin's [system requirements](https://github.com/dolphin-emu/dolphin#system-requirements).
Expand All @@ -38,16 +41,15 @@ Linux/macOS: `~/.config/dolphin-memory-engine`
Create a empty file `portable.txt` in the same directory as Dolphin Memory Engine and the configuration will instead be saved in the same folder as the program.

## How to Build
### Microsoft Windows
This repository provides a solution file for Visual Studio 2022 and later. The Windows SDK Version 10.0.22621.0 is required*.

Before proceeding, ensure the Qt submodule is initialized by running `git submodule update --init` at the repository's root. The files should appear at the `Externals\Qt` directory.
### Microsoft Windows
Visual Studio 2022 and later is recommended. The Windows SDK Version 10.0.22621.0 is required.

Once complete, open the solution file `dolphin-memory-engine.sln` located in the `Source` directory with Visual Studio. Select the build configuration and build it.
The Windows SDK version 10.0.22621.0 comes with the C++ Desktop Development Workload of Visual Studio 2022 — other versions may work but are untested.

#### Windows SDK
The Windows SDK version 10.0.22621.0 comes with the C++ Desktop Development Workload of Visual Studio 2022 — other versions may work but are untested. To use a different Windows SDK you'll need to select it in the project properties window. Please note that this will change the `vcxproj` file, so if you plan to submit a Pull Request, make sure to not stage this change.
Before proceeding, ensure the Qt submodule is initialized by running `git submodule update --init` at the repository's root. The files should appear at the `Externals\Qt` directory.

Once complete, open the `Source` directory with Visual Studio's `Open a local folder` option.

### Linux
> _CMake and Qt 6 are required. Please refer to your distribution's documentation for specific instructions on how to install them._
Expand Down Expand Up @@ -117,15 +119,15 @@ Options:

## Troubleshooting

On Linux, the program may require additional kernel permissions to be able to read and write memory to external processes (which is required to read and write the memory of Dolphin). If nothing happens to Dolphin, but the program frequently unhooks itself, the program is missing the required permissions. Grant these permissions by running the following command as root:
On Linux, the program may require additional kernel permissions to be able to read and write memory to external processes (which is required to read and write the memory of Dolphin). If nothing happens to Dolphin, but the program frequently unhooks itself, the program is missing the required permissions. Grant these permissions by running the following command as root:

setcap cap_sys_ptrace=eip DME
setcap cap_sys_ptrace=eip dolphin-memory-engine

Where `DME` is the path of the Dolphin Memory Engine executable. This should fix the permission problem for future executions.
Where `dolphin-memory-engine` is the path of the Dolphin Memory Engine executable. This sets the permission for future executions.

If it doesn't work, verify that you do not have the `nosuid` mount flag on your `/etc/fstab` as it can cause this command to silently fail.

On macOS, Dolphin (upon install or after an update) must be signed with specific entitlements to permit memory access. Follow the instructions [above](#macos-code-signing).

## License
This program is licensed under the MIT license which grants you the permission to do anything you wish to with the software, as long as you preserve all copyright notices. (See the file LICENSE for the legal text.)
This program is licensed under the MIT license which grants you the permission to do anything you wish to with the software, as long as you preserve all copyright notices. See the file LICENSE for the legal text.
25 changes: 0 additions & 25 deletions Source/dolphin-memory-engine.default.props

This file was deleted.

25 changes: 0 additions & 25 deletions Source/dolphin-memory-engine.sln

This file was deleted.

155 changes: 0 additions & 155 deletions Source/dolphin-memory-engine.vcxproj

This file was deleted.

0 comments on commit ec16678

Please sign in to comment.