Skip to content

Commit

Permalink
readme/whatsnew
Browse files Browse the repository at this point in the history
  • Loading branch information
ianpatt committed Sep 1, 2023
1 parent c3fe0e1 commit d533577
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
49 changes: 49 additions & 0 deletions sfse_readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Starfield Script Extender v0.1.0 pre-alpha
by Ian Patterson

The Starfield Script Extender, or SFSE for short, is a modder's resource that expands the scripting capabilities of Starfield. As the game has literally just released, it's mostly a plugin loader for now. Depending on where modders show interest, this will expand to Scaleform and Papyrus (or other things) over time.

[ Compatibility ]

SFSE will support the latest version of Starfield available on Steam, currently 1.7.23. The Gamepass/MS Store version is unsupported. Do not email asking for support.

[ Installation ]

1. Copy the dll and exe files in to your Starfield folder. This is usually C:\Program Files\Steam\SteamApps\common\Starfield\. Do not put it in your Data folder.
2. Ignore the src folder. It is there for programmers only.
3. Make sure Steam is running, then launch the game by running sfse_loader.exe.

[ FAQ ]

* Xbox version?
- No, not possible due to restrictions put in place by the manufacturers.

* My virus scanner complains about sfse_loader!
- It is not a virus. To extend the game, we use a technique called DLL injection to load our code. Since this technique can also be used by viruses, some badly-written virus scanners assume that any program doing it is a virus. Adding an exception to your scanner's rules may be necessary.

* Can I modify and release my own version of SFSE based on the included source code?
- No; the suggested method for extending SFSE is to write a plugin. If this does not meet your needs, please email the contact addresses listed below.

* Can I include SKSE as part of a mod pack/collection or otherwise rehost the files?
- No. Providing a link to https://www.nexusmods.com/starfield/mods/106 is the suggested method of distribution. Exceptions may be given under applicable circumstances; contact us at the email addresses below. This means that if you see this file available for download anywhere other than https://www.github.com/ianpatt/sfse, or on Nexus by any user other than https://www.nexusmods.com/users/2166624, that service is violating copyright. I don't like having to explicitly spell this out, but my hand has been forced.

* Where did the log files go?
- <My Documents>\My Games\Starfield\SFSE\Logs\

* How do I uninstall SFSE?
- Delete the .dll and .exe files starting with sfse_ from your Starfield folder.

[ Contact ]

Before contacting, make sure that your game launches properly without SFSE first. If SFSE doesn't appear to be working, follow the steps in the FAQ first, then attach everything from <My Documents>\My Games\Starfield\SFSE\Logs\ to an email.

### MAKE SURE TO INCLUDE YOUR LOG FILES AS ATTACHMENTS ###
I cannot help you solve load order problems.
Do not email when a new version of the game is released.

Ian Patterson (ianpatt)
Send email to ianpatt+sfse [at] gmail [dot] com

[ Standard Disclaimer ]

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
3 changes: 3 additions & 0 deletions sfse_whatsnew.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
0.1.0
- plugin manager
- SFSE version shown in pause menu

0 comments on commit d533577

Please sign in to comment.