mirror of
https://github.com/swarm-game/swarm.git
synced 2024-08-16 10:00:27 +03:00
preview rendered world with inotify (#1756)
Opens a live-reloading preview of the world in VS Code. The renderer has been modified to optionally render a blank image instead of crashing upon invalid YAML. ## Prerequisites: Install inotify tools: sudo apt install inotify-tools ## Usage: scripts/preview-world-vscode.sh data/scenarios/Fun/horton.yaml Once the VS Code editor tabs are opened, one can press <kbd>CTRL</kbd> + <kbd>\\</kbd> (backslash) with the image selected to split the editor pane horizontally. One may then navigate to the left-pane's copy of the image preview with <kbd>CTRL</kbd> + <kbd>PageUp</kbd>, and then <kbd>CTRL</kbd> + <kbd>w</kbd> will close the redundant image preview. ## Screenshot ![Screenshot from 2024-01-29 18-53-55](https://github.com/swarm-game/swarm/assets/261693/63a4728c-0ccb-4c08-8cde-61d65e8322b4)
This commit is contained in:
parent
8181cea944
commit
30f6f59385
@ -6,7 +6,7 @@ module Main where
|
|||||||
|
|
||||||
import Options.Applicative
|
import Options.Applicative
|
||||||
import Swarm.Game.Scenario.Topography.Area (AreaDimensions (..))
|
import Swarm.Game.Scenario.Topography.Area (AreaDimensions (..))
|
||||||
import Swarm.Game.World.Render (OuputFormat (..), RenderOpts (..), doRenderCmd)
|
import Swarm.Game.World.Render (FailureMode (..), OuputFormat (..), RenderOpts (..), doRenderCmd)
|
||||||
|
|
||||||
data CLI
|
data CLI
|
||||||
= RenderMap FilePath RenderOpts
|
= RenderMap FilePath RenderOpts
|
||||||
@ -26,6 +26,7 @@ cliParser =
|
|||||||
<*> flag ConsoleText PngImage (long "png" <> help "Render to PNG")
|
<*> flag ConsoleText PngImage (long "png" <> help "Render to PNG")
|
||||||
<*> option str (long "dest" <> short 'd' <> value "output.png" <> help "Output filepath")
|
<*> option str (long "dest" <> short 'd' <> value "output.png" <> help "Output filepath")
|
||||||
<*> optional sizeOpts
|
<*> optional sizeOpts
|
||||||
|
<*> flag Terminate RenderBlankImage (long "fail-blank" <> short 'b' <> help "Render blank image upon failure")
|
||||||
|
|
||||||
seed :: Parser (Maybe Int)
|
seed :: Parser (Maybe Int)
|
||||||
seed = optional $ option auto (long "seed" <> short 's' <> metavar "INT" <> help "Seed to use for world generation")
|
seed = optional $ option auto (long "seed" <> short 's' <> metavar "INT" <> help "Seed to use for world generation")
|
||||||
|
37
scripts/preview-world-vscode.sh
Executable file
37
scripts/preview-world-vscode.sh
Executable file
@ -0,0 +1,37 @@
|
|||||||
|
#!/bin/bash -xe
|
||||||
|
|
||||||
|
# Opens a live-reloading preview of the world
|
||||||
|
#
|
||||||
|
# Prerequisites:
|
||||||
|
# --------------
|
||||||
|
# Install inotify-wait:
|
||||||
|
#
|
||||||
|
# sudo apt install inotify-tools
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# --------------
|
||||||
|
# Once the VS Code editor tabs are opened, one can press
|
||||||
|
# CTRL+\ (backslash) with the image selected to split the
|
||||||
|
# editor pane horizontally.
|
||||||
|
# One may then navigate to the left-pane's copy of the image
|
||||||
|
# preview with CTRL+PageUp, and then
|
||||||
|
# CTRL+w will close the redundant image preview.
|
||||||
|
|
||||||
|
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
|
||||||
|
cd $SCRIPT_DIR/..
|
||||||
|
|
||||||
|
|
||||||
|
SCENARIO_PATH=${1?"Usage: $0 SCENARIO_PATH"}
|
||||||
|
|
||||||
|
IMG_WIDTH=200
|
||||||
|
IMG_HEIGHT=150
|
||||||
|
|
||||||
|
IMG_OUTPUT_PATH=output.png
|
||||||
|
RENDER_IMG_COMMAND="stack exec swarm-scene -- $SCENARIO_PATH --fail-blank --dest $IMG_OUTPUT_PATH --png --width $IMG_WIDTH --height $IMG_HEIGHT"
|
||||||
|
|
||||||
|
stack build --fast swarm:swarm-scene
|
||||||
|
|
||||||
|
$RENDER_IMG_COMMAND
|
||||||
|
code --reuse-window $SCENARIO_PATH && code --reuse-window $IMG_OUTPUT_PATH
|
||||||
|
|
||||||
|
while inotifywait -e close_write $SCENARIO_PATH; do $RENDER_IMG_COMMAND; done
|
@ -28,6 +28,9 @@ data AreaDimensions = AreaDimensions
|
|||||||
, rectHeight :: Int32
|
, rectHeight :: Int32
|
||||||
}
|
}
|
||||||
|
|
||||||
|
asTuple :: AreaDimensions -> (Int32, Int32)
|
||||||
|
asTuple (AreaDimensions x y) = (x, y)
|
||||||
|
|
||||||
renderRectDimensions :: AreaDimensions -> String
|
renderRectDimensions :: AreaDimensions -> String
|
||||||
renderRectDimensions (AreaDimensions w h) =
|
renderRectDimensions (AreaDimensions w h) =
|
||||||
L.intercalate "x" $ map show [w, h]
|
L.intercalate "x" $ map show [w, h]
|
||||||
|
@ -6,9 +6,10 @@ module Swarm.Game.World.Render where
|
|||||||
|
|
||||||
import Codec.Picture
|
import Codec.Picture
|
||||||
import Control.Applicative ((<|>))
|
import Control.Applicative ((<|>))
|
||||||
import Control.Effect.Lift (sendIO)
|
import Control.Carrier.Throw.Either (runThrow)
|
||||||
|
import Control.Effect.Lift (Lift, sendIO)
|
||||||
|
import Control.Effect.Throw
|
||||||
import Control.Lens (view, (^.))
|
import Control.Lens (view, (^.))
|
||||||
import Control.Monad.IO.Class (liftIO)
|
|
||||||
import Data.Colour.SRGB (RGB (..))
|
import Data.Colour.SRGB (RGB (..))
|
||||||
import Data.List.NonEmpty qualified as NE
|
import Data.List.NonEmpty qualified as NE
|
||||||
import Data.Map qualified as M
|
import Data.Map qualified as M
|
||||||
@ -18,6 +19,7 @@ import Data.Vector qualified as V
|
|||||||
import Linear (V2 (..))
|
import Linear (V2 (..))
|
||||||
import Swarm.Game.Display (defaultChar)
|
import Swarm.Game.Display (defaultChar)
|
||||||
import Swarm.Game.Entity.Cosmetic
|
import Swarm.Game.Entity.Cosmetic
|
||||||
|
import Swarm.Game.Failure (SystemFailure)
|
||||||
import Swarm.Game.Location
|
import Swarm.Game.Location
|
||||||
import Swarm.Game.Scenario
|
import Swarm.Game.Scenario
|
||||||
import Swarm.Game.Scenario.Topography.Area
|
import Swarm.Game.Scenario.Topography.Area
|
||||||
@ -28,15 +30,21 @@ import Swarm.Game.State.Landscape
|
|||||||
import Swarm.Game.Universe
|
import Swarm.Game.Universe
|
||||||
import Swarm.Game.World qualified as W
|
import Swarm.Game.World qualified as W
|
||||||
import Swarm.Game.World.Gen (Seed)
|
import Swarm.Game.World.Gen (Seed)
|
||||||
|
import Swarm.Language.Pretty (prettyString)
|
||||||
import Swarm.Util (surfaceEmpty)
|
import Swarm.Util (surfaceEmpty)
|
||||||
import Swarm.Util.Content
|
import Swarm.Util.Content
|
||||||
import Swarm.Util.Effect (simpleErrorHandle)
|
import Swarm.Util.Effect (simpleErrorHandle)
|
||||||
import Swarm.Util.Erasable (erasableToMaybe)
|
import Swarm.Util.Erasable (erasableToMaybe)
|
||||||
|
import System.IO (hPutStrLn, stderr)
|
||||||
|
|
||||||
data OuputFormat
|
data OuputFormat
|
||||||
= ConsoleText
|
= ConsoleText
|
||||||
| PngImage
|
| PngImage
|
||||||
|
|
||||||
|
data FailureMode
|
||||||
|
= Terminate
|
||||||
|
| RenderBlankImage
|
||||||
|
|
||||||
-- | Command-line options for configuring the app.
|
-- | Command-line options for configuring the app.
|
||||||
data RenderOpts = RenderOpts
|
data RenderOpts = RenderOpts
|
||||||
{ renderSeed :: Maybe Seed
|
{ renderSeed :: Maybe Seed
|
||||||
@ -44,6 +52,7 @@ data RenderOpts = RenderOpts
|
|||||||
, outputFormat :: OuputFormat
|
, outputFormat :: OuputFormat
|
||||||
, outputFilepath :: FilePath
|
, outputFilepath :: FilePath
|
||||||
, gridSize :: Maybe AreaDimensions
|
, gridSize :: Maybe AreaDimensions
|
||||||
|
, failureMode :: FailureMode
|
||||||
}
|
}
|
||||||
|
|
||||||
getDisplayChar :: PCell EntityFacade -> Char
|
getDisplayChar :: PCell EntityFacade -> Char
|
||||||
@ -128,12 +137,13 @@ getDisplayGrid vc myScenario ls maybeSize =
|
|||||||
firstScenarioWorld = NE.head $ view scenarioWorlds myScenario
|
firstScenarioWorld = NE.head $ view scenarioWorlds myScenario
|
||||||
|
|
||||||
getRenderableGrid ::
|
getRenderableGrid ::
|
||||||
|
(Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) =>
|
||||||
RenderOpts ->
|
RenderOpts ->
|
||||||
FilePath ->
|
FilePath ->
|
||||||
IO (Grid (PCell EntityFacade), M.Map WorldAttr PreservableColor)
|
m (Grid (PCell EntityFacade), M.Map WorldAttr PreservableColor)
|
||||||
getRenderableGrid (RenderOpts maybeSeed _ _ maybeSize) fp = simpleErrorHandle $ do
|
getRenderableGrid (RenderOpts maybeSeed _ _ maybeSize _) fp = do
|
||||||
(myScenario, gsi) <- loadStandaloneScenario fp
|
(myScenario, gsi) <- loadStandaloneScenario fp
|
||||||
theSeed <- liftIO $ arbitrateSeed maybeSeed myScenario
|
theSeed <- sendIO $ arbitrateSeed maybeSeed myScenario
|
||||||
|
|
||||||
let em = integrateScenarioEntities gsi myScenario
|
let em = integrateScenarioEntities gsi myScenario
|
||||||
worldTuples = buildWorldTuples myScenario
|
worldTuples = buildWorldTuples myScenario
|
||||||
@ -147,13 +157,13 @@ getRenderableGrid (RenderOpts maybeSeed _ _ maybeSize) fp = simpleErrorHandle $
|
|||||||
return (getDisplayGrid vc myScenario myLandscape maybeSize, myScenario ^. scenarioCosmetics)
|
return (getDisplayGrid vc myScenario myLandscape maybeSize, myScenario ^. scenarioCosmetics)
|
||||||
|
|
||||||
doRenderCmd :: RenderOpts -> FilePath -> IO ()
|
doRenderCmd :: RenderOpts -> FilePath -> IO ()
|
||||||
doRenderCmd opts@(RenderOpts _ asPng _ _) mapPath =
|
doRenderCmd opts@(RenderOpts _ asPng _ _ _) mapPath =
|
||||||
case asPng of
|
case asPng of
|
||||||
ConsoleText -> printScenarioMap =<< renderScenarioMap opts mapPath
|
ConsoleText -> printScenarioMap =<< renderScenarioMap opts mapPath
|
||||||
PngImage -> renderScenarioPng opts mapPath
|
PngImage -> renderScenarioPng opts mapPath
|
||||||
|
|
||||||
renderScenarioMap :: RenderOpts -> FilePath -> IO [String]
|
renderScenarioMap :: RenderOpts -> FilePath -> IO [String]
|
||||||
renderScenarioMap opts fp = do
|
renderScenarioMap opts fp = simpleErrorHandle $ do
|
||||||
(grid, _) <- getRenderableGrid opts fp
|
(grid, _) <- getRenderableGrid opts fp
|
||||||
return $ unGrid $ getDisplayChar <$> grid
|
return $ unGrid $ getDisplayChar <$> grid
|
||||||
|
|
||||||
@ -164,8 +174,19 @@ gridToVec (Grid g) = V.fromList . map V.fromList $ g
|
|||||||
|
|
||||||
renderScenarioPng :: RenderOpts -> FilePath -> IO ()
|
renderScenarioPng :: RenderOpts -> FilePath -> IO ()
|
||||||
renderScenarioPng opts fp = do
|
renderScenarioPng opts fp = do
|
||||||
(grid, aMap) <- getRenderableGrid opts fp
|
result <- runThrow $ getRenderableGrid opts fp
|
||||||
writePng (outputFilepath opts) $ mkImg aMap grid
|
img <- case result of
|
||||||
|
Left (err :: SystemFailure) -> case failureMode opts of
|
||||||
|
Terminate -> fail errorMsg
|
||||||
|
RenderBlankImage -> do
|
||||||
|
hPutStrLn stderr errorMsg
|
||||||
|
let s = maybe (1, 1) (both fromIntegral . asTuple) $ gridSize opts
|
||||||
|
return $ uncurry (generateImage $ \_x _y -> PixelRGBA8 0 0 0 255) s
|
||||||
|
where
|
||||||
|
errorMsg :: String
|
||||||
|
errorMsg = prettyString err
|
||||||
|
Right (grid, aMap) -> return $ mkImg aMap grid
|
||||||
|
writePng (outputFilepath opts) img
|
||||||
where
|
where
|
||||||
mkImg aMap g = generateImage (pixelRenderer vecGrid) (fromIntegral w) (fromIntegral h)
|
mkImg aMap g = generateImage (pixelRenderer vecGrid) (fromIntegral w) (fromIntegral h)
|
||||||
where
|
where
|
||||||
|
Loading…
Reference in New Issue
Block a user