Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Load any mod on any platform #166

Closed
5 tasks done
Pathoschild opened this issue Nov 7, 2016 · 6 comments
Closed
5 tasks done

Load any mod on any platform #166

Pathoschild opened this issue Nov 7, 2016 · 6 comments
Assignees
@Pathoschild
Labels
enhancement This is a general improvement that can be addressed with specific development changes.
Milestone
1.3

Comments

@Pathoschild
Copy link
Owner

Pathoschild commented Nov 7, 2016 •
edited
Loading

SMAPI should support all mods on all platform (Linux/Mac/Windows), regardless of which platform the mods were compiled on. (Use Mono.Cecil to dynamically adjust the assemblies to use the correct dependencies.)

To do

  • Preprocess all mod assemblies through Cecil.
  • Cache preprocessed assemblies in Mods/.cache.
  • Invalidate cache when assembly's MD5 hash changes.
  • Rewrite mod assemblies to change references.
  • Rewrite mod assemblies to address API changes between XNA and MonoGame.
@Pathoschild Pathoschild added the enhancement This is a general improvement that can be addressed with specific development changes. label Nov 7, 2016
@Pathoschild Pathoschild added this to the 1.1 milestone Nov 7, 2016
@Pathoschild
Copy link
Owner Author

Pathoschild commented Nov 7, 2016 •
edited
Loading

See prototype implementation in Farmhand, with permission to backport into SMAPI.

@spacechase0 spacechase0 mentioned this issue Nov 10, 2016
Closed
@Pathoschild Pathoschild modified the milestones: 2.0, 1.1, 1.2 Nov 16, 2016
@Pathoschild Pathoschild modified the milestones: 1.3, 1.2 Nov 26, 2016
@Pathoschild Pathoschild self-assigned this Nov 26, 2016
@Pathoschild
Copy link
Owner Author

Pathoschild commented Nov 27, 2016 •
edited
Loading

Making some progress on this. SMAPI 1.3 now rewrites mod assemblies using Mono.Cecil to convert types between MonoGame and XNA as needed by the current platform.

  • SMAPI 1.3 on Windows should now support most Linux/Mac mods. There are a few edge cases where method signatures are inconsistent between MonoGame and XNA (mainly SpriteBatch::Begin), but few mods will be affected by this. I'll look into the edge cases more once I've figured out the next point.
  • SMAPI 1.3 on Linux/Mac supports a few Windows mods. Most mods fail with variations of this error:
    image
    I haven't figured out why that happens yet, but I suspect it's the last big blocker for supporting most mods.

@Pathoschild
Copy link
Owner Author

SMAPI 1.3 now runs most mods on Linux/Mac and Windows, regardless of their original platform. Some mods are affected by API differences between the two (e.g. SpriteBatch.Begin has a different method signature), which will need to be rewritten too.

Pathoschild added a commit that referenced this issue Nov 29, 2016
@Pathoschild
move assembly map into constants (#166)
f3675aa
@spacechase0 spacechase0 mentioned this issue Nov 29, 2016
Closed
Pathoschild added a commit that referenced this issue Nov 29, 2016
@Pathoschild
move dependencies into targets file for reuse (#166)
b425e32
Pathoschild added a commit that referenced this issue Nov 29, 2016
@Pathoschild
add separate project to support upcoming IL rewriting (#166)
5470e95
Pathoschild added a commit that referenced this issue Nov 29, 2016
@Pathoschild
add framework for rewriting incompatible methods (#166)
cc4d3c1
Pathoschild added a commit that referenced this issue Nov 30, 2016
@Pathoschild
rewrite SpriteBatch.Begin calls for compatibility (#166)
9ff9d02
Pathoschild added a commit that referenced this issue Nov 30, 2016
@Pathoschild
exclude rewriters project from IL weaving (#166)
528a934
Pathoschild added a commit that referenced this issue Nov 30, 2016
@Pathoschild
update release notes (#166)
98a3289
Pathoschild added a commit that referenced this issue Nov 30, 2016
@Pathoschild
update readme & installer for 1.3 (#166)
7e17005
@Pathoschild
Copy link
Owner Author

Pathoschild commented Nov 30, 2016 •
edited
Loading

Done and merged into the develop branch; pending alpha testing before release.

Pathoschild added a commit that referenced this issue Dec 1, 2016
@Pathoschild
fix assembly resolution failing for rewritten mods that reference a d…
44dfb6f 
…ifferent version of Json.NET (#166)
Pathoschild added a commit that referenced this issue Dec 1, 2016
@Pathoschild
invalidate assembly rewrite cache on new SMAPI version (#166)
33f46d2
Pathoschild added a commit that referenced this issue Dec 1, 2016
@Pathoschild
remove Costura assembly weaving (#166)
67feb7e 
This didn't work on Linux or Mac, caused assembly resolution problems when rewritten mods referenced Json.NET, complicated debugging, and wasn't really needed since players use the installer to cleanly add or remove SMAPI.
@Pathoschild
Copy link
Owner Author

Pathoschild commented Dec 1, 2016 •
edited
Loading

Known mod issues:

mod issue found via status
Better Sprinklers JSON parse error on Linux/Mac testing ✓fixed in 2.0-EntoPatch5
FarmAutomation.ItemCollector config stored in .cache directory
(reported for official and unofficial version)		 forums ✘ open
Loved Labels hardcoded path separator testing ✘ open

Pathoschild added a commit that referenced this issue Dec 2, 2016
@Pathoschild
fix assembly resolution when mods try to load types from other mods (#…
ad773a9 
…166)
Pathoschild added a commit that referenced this issue Dec 2, 2016
@Pathoschild
reduce logging levels (#166)
788a906
@Pathoschild
Copy link
Owner Author

This was released with SMAPI 1.3 and seems to be working pretty well. We can open new issues for further improvements as needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Pathoschild Pathoschild

Labels
enhancement This is a general improvement that can be addressed with specific development changes.
Projects
None yet
Milestone
1.3
Development

No branches or pull requests
1 participant
@Pathoschild