- 
                Notifications
    You must be signed in to change notification settings 
- Fork 18
Add sections on world loading #39
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.
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
          
     Open
      
      
            LooFifteen
  wants to merge
  2
  commits into
  Minestom:master
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
LooFifteen:docs/loading
  
      
      
   
  
    
  
  
  
 
  
      
    base: master
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
  
     Open
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            2 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      
    File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              This file was deleted.
      
      Oops, something went wrong.
      
    
  
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # World Loading | ||
|  | ||
| In order to load or save an [`Instance`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html), you must provide a [`ChunkLoader`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/ChunkLoader.html) that Minestom will use to read and write chunk data to and from. | ||
|  | ||
| When creating your instance, you can provide the loader in multiple ways: | ||
| * [`InstanceManager#createInstanceContainer(@Nullable ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.ChunkLoader)) | ||
| * [`InstanceManager#createInstanceContainer(RegistryKey<DimensionType>, @Nullable ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceManager.html#createInstanceContainer(net.minestom.server.instance.ChunkLoader)) | ||
| * [`InstanceContainer#setChunkLoader(ChunkLoader)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/InstanceContainer.html#setChunkLoader(net.minestom.server.instance.ChunkLoader)) | ||
|  | ||
| Minestom will automatically load chunks from the loader once provided. | ||
|  | ||
| ## Saving | ||
|  | ||
| Saving must be done in two steps: | ||
| 1. [`Instance#saveChunksToStorage`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html#saveChunksToStorage()) | ||
| 2. [`Instance#saveInstance`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/Instance.html#saveInstance()) | ||
|  | ||
| ```java | ||
| MinecraftServer.getSchedulerManager().buildShutdownTask(() -> { | ||
| this.instance.saveChunksToStorage(); | ||
| this.instance.saveInstance(); | ||
| }); | ||
| ``` | ||
|  | ||
| ## Loaders | ||
|  | ||
| * [No-op](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/ChunkLoader.html#noop()) | ||
| * [Anvil](/docs/world/loading/anvil.md) | ||
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Anvil Loader | ||
|  | ||
| Anvil is the format made by Mojang for vanilla. Minestom provides this format and it is chosen **by default** on newly created instances. Anvil is a multi-file world format, so must be provided with a directory to store world data. The anvil loader also supports reading light data from the worlds, this is enabled by default. | ||
|  | ||
| ## Requirements | ||
|  | ||
| Worlds to be used with [`AnvilLoader`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/anvil/AnvilLoader.html) only need to contain the `region` directory, which is where the chunk data comes from. Chunk loaders do not read entity data. | ||
|  | ||
| ## Usage | ||
|  | ||
| To use a world from the **runtime file system**, you can do something like the following code snippet, which constructs the loader using [`AnvilLoader#<init>(Path)`](https://javadoc.minestom.net/net.minestom.server/net/minestom/server/instance/anvil/AnvilLoader.html#%3Cinit%3E(java.nio.file.Path)). | ||
|  | ||
| ```java | ||
| final Path directory = this.worlds.join("world"); | ||
| final AnvilLoader loader = new AnvilLoader(directory); | ||
| final InstanceContainer instance = MinecraftServer.getInstanceManager().createInstanceContainer(loader); | ||
| ``` | ||
|  | ||
| Remember, however, that this **does not** read from the jar resources. Other war crimes must be committed for this to happen. | 
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haven't tested but pretty sure this won't work. Shouldn't they be without
.md? So just/docs/world/loading/{anvil,polar}There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works on the local development server. I'd also assume that would work when the site is generated.